Skip to content

Copies Atlas CLI commands for release tag: atlascli/v1.43.1 #1120

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

Closed
Closed
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
  •  
  •  
  •  
8 changes: 5 additions & 3 deletions source/command/atlas-accessLists-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLists create
========================

.. meta::
:description: Create an IP access list entry for your project using trusted IPs, AWS security group IDs, or CIDR notation without overwriting existing entries.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-accessLists-delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLists delete
========================

.. meta::
:description: Remove an IP access list entry from your Atlas project using the CLI, with options for confirmation and project specification.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-accessLists-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLists describe
==========================

.. meta::
:description: Retrieve details of a specified IP access list entry using the Atlas CLI command with options for output format and project ID.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-accessLists-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLists list
======================

.. meta::
:description: List all IP access entries for your project using the Atlas CLI command with various output and pagination options.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
10 changes: 7 additions & 3 deletions source/command/atlas-accessLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLists
=================

.. meta::
:description: Manage IP access lists for your Atlas project using the CLI, including creating, deleting, and listing entries.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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 source/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
10 changes: 7 additions & 3 deletions source/command/atlas-accessLogs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas accessLogs
================

.. meta::
:description: Retrieve access logs for a cluster using the Atlas CLI command with optional profile settings.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
9 changes: 9 additions & 0 deletions source/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 Expand Up @@ -61,6 +66,8 @@ Options
-
- false
- Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command.

Mutually exclusive with --until.
* - -h, --help
-
- false
Expand All @@ -78,6 +85,8 @@ Options
- false
- ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged.

Mutually exclusive with --forever.

Inherited Options
-----------------

Expand Down
5 changes: 5 additions & 0 deletions source/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 source/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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings create
============================

.. meta::
:description: Create an alert configuration for your project using the Atlas CLI with various options for notification and metric settings.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings delete
============================

.. meta::
:description: Delete a specified alert configuration in your project using the Atlas CLI, requiring authentication with a Project Owner role.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings describe
==============================

.. meta::
:description: Retrieve details of specific alert settings for your project using the Atlas CLI command with options for output format and project ID.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
10 changes: 7 additions & 3 deletions source/command/atlas-alerts-settings-disable.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings disable
=============================

.. meta::
:description: Disable an alert configuration for a specified project using the Atlas CLI command with options for output format and project ID.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
10 changes: 7 additions & 3 deletions source/command/atlas-alerts-settings-enable.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings enable
============================

.. meta::
:description: Enable an alert configuration for a specified project using the Atlas CLI command with options for output format and project ID.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-fields-type.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings fields type
=================================

.. meta::
:description: Retrieve available field types for the matcherFieldName option in alert configurations using the Atlas CLI.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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 source/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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings list
==========================

.. meta::
:description: Retrieve all alert configurations for your project using the Atlas CLI command with various output and pagination options.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
8 changes: 5 additions & 3 deletions source/command/atlas-alerts-settings-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings update
============================

.. meta::
:description: Update alert configurations in your project using the Atlas CLI, requiring authentication and offering various options for customization.

.. default-domain:: mongodb

.. contents:: On this page
Expand All @@ -17,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
Loading