Skip to content

Test 9 #986

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
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
  •  
  •  
  •  
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 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 Down
3 changes: 0 additions & 3 deletions source/command/atlas-alerts-settings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts settings
=====================

.. meta::
:description: Manage alert configurations for your project by listing, creating, editing, deleting, enabling, and disabling alerts.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 0 additions & 3 deletions source/command/atlas-alerts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
atlas alerts
============

.. meta::
:description: Manage project alerts using the Atlas CLI with commands to list, acknowledge, describe, and configure alerts.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -113,13 +113,11 @@ Inherited Options
- 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
atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

.. Code end marker, please don't delete this comment

Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -113,13 +113,11 @@ Inherited Options
- 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
atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname]

.. Code end marker, please don't delete this comment

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -96,13 +96,11 @@ Inherited Options
- 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
atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8

.. Code end marker, please don't delete this comment

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -96,13 +96,11 @@ Inherited Options
- 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
atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8

.. Code end marker, please don't delete this comment

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -104,13 +104,11 @@ Inherited Options
- 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 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

Loading