diff --git a/source/command/atlas-accessLists-create.txt b/source/command/atlas-accessLists-create.txt index 7b147c89..f6bd3872 100644 --- a/source/command/atlas-accessLists-create.txt +++ b/source/command/atlas-accessLists-create.txt @@ -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 diff --git a/source/command/atlas-accessLists-delete.txt b/source/command/atlas-accessLists-delete.txt index c0217c72..9422e699 100644 --- a/source/command/atlas-accessLists-delete.txt +++ b/source/command/atlas-accessLists-delete.txt @@ -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 diff --git a/source/command/atlas-accessLists-describe.txt b/source/command/atlas-accessLists-describe.txt index 2a661a5c..b759f71c 100644 --- a/source/command/atlas-accessLists-describe.txt +++ b/source/command/atlas-accessLists-describe.txt @@ -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 diff --git a/source/command/atlas-accessLists-list.txt b/source/command/atlas-accessLists-list.txt index c9cf6b92..7fc06813 100644 --- a/source/command/atlas-accessLists-list.txt +++ b/source/command/atlas-accessLists-list.txt @@ -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 diff --git a/source/command/atlas-accessLists.txt b/source/command/atlas-accessLists.txt index d05c2947..0c5ab90e 100644 --- a/source/command/atlas-accessLists.txt +++ b/source/command/atlas-accessLists.txt @@ -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 diff --git a/source/command/atlas-accessLogs.txt b/source/command/atlas-accessLogs.txt index 027746db..6af9d051 100644 --- a/source/command/atlas-accessLogs.txt +++ b/source/command/atlas-accessLogs.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-create.txt b/source/command/atlas-alerts-settings-create.txt index 53d9006e..87a1e7c5 100644 --- a/source/command/atlas-alerts-settings-create.txt +++ b/source/command/atlas-alerts-settings-create.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-delete.txt b/source/command/atlas-alerts-settings-delete.txt index d777d3ec..8e22299a 100644 --- a/source/command/atlas-alerts-settings-delete.txt +++ b/source/command/atlas-alerts-settings-delete.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-describe.txt b/source/command/atlas-alerts-settings-describe.txt index d631c063..323cc68f 100644 --- a/source/command/atlas-alerts-settings-describe.txt +++ b/source/command/atlas-alerts-settings-describe.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-disable.txt b/source/command/atlas-alerts-settings-disable.txt index 63ab63f8..c63bbd53 100644 --- a/source/command/atlas-alerts-settings-disable.txt +++ b/source/command/atlas-alerts-settings-disable.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-enable.txt b/source/command/atlas-alerts-settings-enable.txt index 0d05c9bd..9e543312 100644 --- a/source/command/atlas-alerts-settings-enable.txt +++ b/source/command/atlas-alerts-settings-enable.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-fields-type.txt b/source/command/atlas-alerts-settings-fields-type.txt index f94a23dc..891a1ed7 100644 --- a/source/command/atlas-alerts-settings-fields-type.txt +++ b/source/command/atlas-alerts-settings-fields-type.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-list.txt b/source/command/atlas-alerts-settings-list.txt index e764e2bc..18033d8b 100644 --- a/source/command/atlas-alerts-settings-list.txt +++ b/source/command/atlas-alerts-settings-list.txt @@ -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 diff --git a/source/command/atlas-alerts-settings-update.txt b/source/command/atlas-alerts-settings-update.txt index 291a466d..a5355972 100644 --- a/source/command/atlas-alerts-settings-update.txt +++ b/source/command/atlas-alerts-settings-update.txt @@ -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 diff --git a/source/command/atlas-alerts-settings.txt b/source/command/atlas-alerts-settings.txt index 9c2c0f1a..54f985be 100644 --- a/source/command/atlas-alerts-settings.txt +++ b/source/command/atlas-alerts-settings.txt @@ -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 diff --git a/source/command/atlas-alerts.txt b/source/command/atlas-alerts.txt index 791c48fa..75f0f715 100644 --- a/source/command/atlas-alerts.txt +++ b/source/command/atlas-alerts.txt @@ -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 diff --git a/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 14a4da4f..f77898b9 100644 --- a/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByClusterName `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --start - int - false @@ -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 diff --git a/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 7f929a0a..a3101afb 100644 --- a/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByHostname `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --start - int - false @@ -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 diff --git a/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index ff5c02f7..d8f8821a 100644 --- a/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations createAlertConfiguration `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 79ff4a66..60156e5f 100644 --- a/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations deleteAlertConfiguration `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -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 diff --git a/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index dd2f27e9..cb88f3de 100644 --- a/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations getAlertConfiguration `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -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 diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 7559fa15..f25e185a 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -60,7 +60,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 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 - diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 4ef5753b..c5229f88 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurations `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -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 diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 668d4084..4c617778 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,13 +108,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 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 diff --git a/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 5754a6b8..3e570e85 100644 --- a/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations toggleAlertConfiguration `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 14daf086..146e1c04 100644 --- a/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations updateAlertConfiguration `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alerts-acknowledgeAlert.txt b/source/command/atlas-api-alerts-acknowledgeAlert.txt index 5bff53f0..27a13520 100644 --- a/source/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/source/command/atlas-api-alerts-acknowledgeAlert.txt @@ -14,7 +14,7 @@ atlas api alerts acknowledgeAlert `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alerts-getAlert.txt b/source/command/atlas-api-alerts-getAlert.txt index be229e75..1fddfe06 100644 --- a/source/command/atlas-api-alerts-getAlert.txt +++ b/source/command/atlas-api-alerts-getAlert.txt @@ -14,7 +14,7 @@ atlas api alerts getAlert `Public Preview: please provide feedback at `_: 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -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 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 diff --git a/source/command/atlas-api-alerts-listAlerts.txt b/source/command/atlas-api-alerts-listAlerts.txt index 1eb42d16..b4cfbceb 100644 --- a/source/command/atlas-api-alerts-listAlerts.txt +++ b/source/command/atlas-api-alerts-listAlerts.txt @@ -14,7 +14,7 @@ atlas api alerts listAlerts `Public Preview: please provide feedback at `_: Returns all alerts. -These alerts apply to all components 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. +These alerts apply to all components 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. 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 prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --status - string - false @@ -108,13 +108,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 alerts listAlerts --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alerts listAlerts --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 5a2ffdf1..a696c802 100644 --- a/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -14,7 +14,7 @@ atlas api alerts listAlertsByAlertConfigurationId `Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. -These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role. +These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. 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 @@ -85,7 +85,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 prettyprint format. * - --version - string - false @@ -108,13 +108,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 alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 858fb2e2..11f3fa49 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 9e9ad70b..2cea5edc 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch createAtlasSearchIndex `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/createAtlasSearchIndex. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 84f9f1b6..bb2ec7a3 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/createAtlasSearchIndexDeprecated. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 053fedce..4da64485 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -99,13 +99,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 atlasSearch deleteAtlasSearchDeployment --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch deleteAtlasSearchDeployment --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index 812c236c..7e533b7d 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndex `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. 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/Atlas-Search/operation/deleteAtlasSearchIndex. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 atlasSearch deleteAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch deleteAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index e5ea0998..9d21ea46 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndexByName `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. -To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. 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/Atlas-Search/operation/deleteAtlasSearchIndexByName. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 atlasSearch deleteAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] --pretty false + atlas api atlasSearch deleteAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 7997c2b1..dfd7a77d 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -To use this resource, the requesting API Key must have the Project Data Access Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 atlasSearch deleteAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch deleteAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index a1957962..729799a7 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 atlasSearch getAtlasSearchDeployment --version 2025-03-12 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch getAtlasSearchDeployment --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index cbaf4cae..0a71d071 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 atlasSearch getAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch getAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index 1f2b40f9..fea48b3b 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 atlasSearch getAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] --pretty false + atlas api atlasSearch getAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index f67219b2..dea309a2 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated `Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. -You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. +You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write 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/Atlas-Search/operation/getAtlasSearchIndexDeprecated. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 atlasSearch getAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch getAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 3e0477dc..744cbafb 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexes `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write 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/Atlas-Search/operation/listAtlasSearchIndexes. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 atlasSearch listAtlasSearchIndexes --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexes --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index fe013e89..8e8de9bc 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexesCluster `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write 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/Atlas-Search/operation/listAtlasSearchIndexesCluster. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 atlasSearch listAtlasSearchIndexesCluster --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexesCluster --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 0795481f..a97a3803 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write 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/Atlas-Search/operation/listAtlasSearchIndexesDeprecated. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 atlasSearch listAtlasSearchIndexesDeprecated --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexesDeprecated --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 724eb6b5..ee42d9c4 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 9d3681b7..413ce2d2 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndex `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/updateAtlasSearchIndex. @@ -78,7 +78,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 8561f60c..5b878444 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndexByName `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/updateAtlasSearchIndexByName. @@ -86,7 +86,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index e7fa38ab..e6d57576 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Atlas-Search/operation/updateAtlasSearchIndexDeprecated. @@ -78,7 +78,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-auditing-getAuditingConfiguration.txt b/source/command/atlas-api-auditing-getAuditingConfiguration.txt index 2e6e28dd..ab9ae6ac 100644 --- a/source/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/source/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -14,7 +14,7 @@ atlas api auditing getAuditingConfiguration `Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. -The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. 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/Auditing/operation/getAuditingConfiguration. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 auditing getAuditingConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api auditing getAuditingConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-auditing-updateAuditingConfiguration.txt b/source/command/atlas-api-auditing-updateAuditingConfiguration.txt index fef89b00..4ab75ec0 100644 --- a/source/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/source/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -14,7 +14,7 @@ atlas api auditing updateAuditingConfiguration `Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. -The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. 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/Auditing/operation/updateAuditingConfiguration. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index c06b7298..696f1bbd 100644 --- a/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -14,7 +14,7 @@ atlas api awsClustersDns getAwsCustomDns `Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in 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. 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/AWS-Clusters-DNS/operation/getAwsCustomDns. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 awsClustersDns getAwsCustomDns --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api awsClustersDns getAwsCustomDns --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 4ba68ac2..b27bb4e9 100644 --- a/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -14,7 +14,7 @@ atlas api awsClustersDns toggleAwsCustomDns `Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. -Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. +Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas 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/AWS-Clusters-DNS/operation/toggleAwsCustomDns. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 85674632..a7e63e7b 100644 --- a/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups cancelBackupRestoreJob `Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/cancelBackupRestoreJob. @@ -70,7 +70,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 prettyprint format. * - --restoreJobId - string - true @@ -97,13 +97,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 cloudBackups cancelBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups cancelBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-createBackupExportJob.txt b/source/command/atlas-api-cloudBackups-createBackupExportJob.txt index 7f25304c..f40b13af 100644 --- a/source/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/source/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createBackupExportJob `Public Preview: please provide feedback at `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -To use this resource, the requesting API Key must have the Project Atlas Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Atlas 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/Cloud-Backups/operation/createBackupExportJob. diff --git a/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 44576b6a..57565470 100644 --- a/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -17,7 +17,7 @@ atlas api cloudBackups createBackupRestoreJob Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/createBackupRestoreJob. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-createExportBucket.txt b/source/command/atlas-api-cloudBackups-createExportBucket.txt index 325bc356..61760301 100644 --- a/source/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-createExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createExportBucket `Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. -Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. +Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Backups/operation/createExportBucket. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,18 +93,18 @@ 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 ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_aws - AWS - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS { "bucketName": "export-bucket", "cloudProvider": "AWS", @@ -113,23 +113,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS + atlas api cloudBackups createExportBucket --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2024-05-30_aws - AWS - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS { "bucketName": "export-bucket", "cloudProvider": "AWS", @@ -138,24 +138,25 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS + atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2024-05-30_azure - Azure - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Azure { + "bucketName": "examplecontainer", "cloudProvider": "AZURE", "roleId": "668c5f0ed436263134491592", "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" @@ -163,11 +164,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Azure + atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 8dcab107..73d16ae8 100644 --- a/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createServerlessBackupRestoreJob `Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 79ab8891..a176c33f 100644 --- a/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteAllBackupSchedules `Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. -This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas 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/Cloud-Backups/operation/deleteAllBackupSchedules. @@ -89,13 +89,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 cloudBackups deleteAllBackupSchedules --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups deleteAllBackupSchedules --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteExportBucket.txt b/source/command/atlas-api-cloudBackups-deleteExportBucket.txt index 54dd6841..df33dffd 100644 --- a/source/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteExportBucket `Public Preview: please provide feedback at `_: Deletes an Export Bucket. -Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Backup Manager role. +Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/deleteExportBucket. @@ -89,13 +89,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 cloudBackups deleteExportBucket --version 2023-01-01 --envelope false --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups deleteExportBucket --version 2023-01-01 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 03e2f93d..b6ce43cd 100644 --- a/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteReplicaSetBackup `Public Preview: please provide feedback at `_: Removes the specified snapshot. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/deleteReplicaSetBackup. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -105,13 +105,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 cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 1d5ec35f..3d6ab2de 100644 --- a/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteShardedClusterBackup `Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/deleteShardedClusterBackup. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -97,13 +97,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 cloudBackups deleteShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups deleteShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index cf67da0f..148c9d46 100644 --- a/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups disableDataProtectionSettings `Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. -As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting API Key must have the Project Owner role. +As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Backups/operation/disableDataProtectionSettings. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 cloudBackups disableDataProtectionSettings --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups disableDataProtectionSettings --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupExportJob.txt b/source/command/atlas-api-cloudBackups-getBackupExportJob.txt index a8e303b2..ee8d75f0 100644 --- a/source/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/source/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupExportJob `Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -To use this resource, the requesting API Key must have the Project Atlas Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Atlas 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/Cloud-Backups/operation/getBackupExportJob. @@ -93,13 +93,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 cloudBackups getBackupExportJob --version 2023-01-01 --clusterName [clusterName] --envelope false --exportId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getBackupExportJob --version 2023-01-01 --clusterName [clusterName] --exportId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index b0c70861..138e9cf2 100644 --- a/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupRestoreJob `Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/getBackupRestoreJob. @@ -70,7 +70,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 prettyprint format. * - --restoreJobId - string - true @@ -97,13 +97,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 cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupSchedule.txt b/source/command/atlas-api-cloudBackups-getBackupSchedule.txt index 19d3ac75..9e5da7a8 100644 --- a/source/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/source/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupSchedule `Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. -This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Cloud-Backups/operation/getBackupSchedule. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index cc5f7d06..d2eaca8f 100644 --- a/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getDataProtectionSettings `Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Backups/operation/getDataProtectionSettings. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 cloudBackups getDataProtectionSettings --version 2023-10-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups getDataProtectionSettings --version 2023-10-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getExportBucket.txt b/source/command/atlas-api-cloudBackups-getExportBucket.txt index 9189b7ce..1de4b3dc 100644 --- a/source/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-getExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getExportBucket `Public Preview: please provide feedback at `_: Returns one Export Bucket associated with 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. 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/Cloud-Backups/operation/getExportBucket. @@ -89,13 +89,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 cloudBackups getExportBucket --version 2024-05-30 --envelope false --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getExportBucket --version 2024-05-30 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 81ac9377..1b2cd28b 100644 --- a/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getReplicaSetBackup `Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. -To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager 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/Cloud-Backups/operation/getReplicaSetBackup. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -97,13 +97,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 cloudBackups getReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups getReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getServerlessBackup.txt b/source/command/atlas-api-cloudBackups-getServerlessBackup.txt index 0380b83b..06836394 100644 --- a/source/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/source/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getServerlessBackup `Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance 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. This endpoint can also be used on Flex clusters that were created with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. @@ -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 cloudBackups getServerlessBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --snapshotId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getServerlessBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 9e252bb0..252a4673 100644 --- a/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getServerlessBackupRestoreJob `Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. @@ -73,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 prettyprint format. * - --restoreJobId - string - true @@ -100,13 +100,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 cloudBackups getServerlessBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups getServerlessBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index a9b1eb53..7d25d53d 100644 --- a/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getShardedClusterBackup `Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. -To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager 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/Cloud-Backups/operation/getShardedClusterBackup. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -97,13 +97,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 cloudBackups getShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups getShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 7d4ffeee..622abea8 100644 --- a/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listBackupExportJobs `Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -To use this resource, the requesting API Key must have the Project Atlas Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Atlas 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/Cloud-Backups/operation/listBackupExportJobs. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 cloudBackups listBackupExportJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listBackupExportJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 8d4008f8..a4a3e355 100644 --- a/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listBackupRestoreJobs `Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/listBackupRestoreJobs. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 cloudBackups listBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listExportBuckets.txt b/source/command/atlas-api-cloudBackups-listExportBuckets.txt index 271be817..832b61cf 100644 --- a/source/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/source/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listExportBuckets `Public Preview: please provide feedback at `_: Returns all Export Buckets associated with 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. 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/Cloud-Backups/operation/listExportBuckets. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 cloudBackups listExportBuckets --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listExportBuckets --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 8a3d4f19..28b6373e 100644 --- a/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listReplicaSetBackups `Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. -To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager 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/Cloud-Backups/operation/listReplicaSetBackups. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 cloudBackups listReplicaSetBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listReplicaSetBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 77298596..3cfd13c4 100644 --- a/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listServerlessBackupRestoreJobs `Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. @@ -85,7 +85,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 prettyprint format. * - --version - string - false @@ -108,13 +108,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 cloudBackups listServerlessBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listServerlessBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listServerlessBackups.txt b/source/command/atlas-api-cloudBackups-listServerlessBackups.txt index ee748a3f..e18dc022 100644 --- a/source/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/source/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listServerlessBackups `Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance 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. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. @@ -85,7 +85,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 prettyprint format. * - --version - string - false @@ -108,13 +108,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 cloudBackups listServerlessBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listServerlessBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 3c19e763..627fceac 100644 --- a/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listShardedClusterBackups `Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. -To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager 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/Cloud-Backups/operation/listShardedClusterBackups. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 cloudBackups listShardedClusterBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups listShardedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-takeSnapshot.txt b/source/command/atlas-api-cloudBackups-takeSnapshot.txt index 2d68c2ab..19d16d0b 100644 --- a/source/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/source/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -17,7 +17,7 @@ atlas api cloudBackups takeSnapshot Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. -To use this resource, the requesting API Key must have the Project Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager 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/Cloud-Backups/operation/takeSnapshot. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 3eca52fb..79ec0477 100644 --- a/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -14,7 +14,7 @@ atlas api cloudBackups updateBackupSchedule `Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. -This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Owner role. +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Backups/operation/updateBackupSchedule. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 266d006a..f64343d2 100644 --- a/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups updateDataProtectionSettings `Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Backups/operation/updateDataProtectionSettings. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 5cabb90e..48703708 100644 --- a/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -74,7 +74,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 prettyprint format. * - --snapshotId - string - true diff --git a/source/command/atlas-api-cloudMigrationService-createLinkToken.txt b/source/command/atlas-api-cloudMigrationService-createLinkToken.txt index f9d116a8..64837e18 100644 --- a/source/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/source/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudMigrationService-createPushMigration.txt b/source/command/atlas-api-cloudMigrationService-createPushMigration.txt index 07d0dcf8..f2c1ebc4 100644 --- a/source/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -76,7 +76,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt index de7342ed..12c84cab 100644 --- a/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 cloudMigrationService cutoverMigration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 --pretty false + atlas api cloudMigrationService cutoverMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index 61690d44..26cf8603 100644 --- a/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -83,13 +83,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 cloudMigrationService deleteLinkToken --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 + atlas api cloudMigrationService deleteLinkToken --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-getPushMigration.txt b/source/command/atlas-api-cloudMigrationService-getPushMigration.txt index cefa8a15..fb05db42 100644 --- a/source/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 cloudMigrationService getPushMigration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 --pretty false + atlas api cloudMigrationService getPushMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 277e5bbd..61c57456 100644 --- a/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -89,13 +89,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 cloudMigrationService getValidationStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011 + atlas api cloudMigrationService getValidationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 78d80dd6..27a916ed 100644 --- a/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -62,7 +62,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 prettyprint format. * - --version - string - false @@ -85,13 +85,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 cloudMigrationService listSourceProjects --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api cloudMigrationService listSourceProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-validateMigration.txt b/source/command/atlas-api-cloudMigrationService-validateMigration.txt index 64e4dadf..414b9ee2 100644 --- a/source/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 17e0f4fc..0a245bb6 100644 --- a/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole `Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. -To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. 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/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole. @@ -70,7 +70,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 prettyprint format. * - --roleId - string - true diff --git a/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index f2ff4188..3f7b8f9a 100644 --- a/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess createCloudProviderAccessRole `Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. -Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting API Key must have the Project Owner role. +Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Provider-Access/operation/createCloudProviderAccessRole. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index db8a0f33..f958b087 100644 --- a/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole `Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole. @@ -70,7 +70,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 prettyprint format. * - --roleId - string - true @@ -97,13 +97,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 cloudProviderAccess deauthorizeCloudProviderAccessRole --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleId [roleId] + atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index e47baf2c..90500e4c 100644 --- a/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess getCloudProviderAccessRole `Public Preview: please provide feedback at `_: Returns the access role with the specified id and with access to the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Provider-Access/operation/getCloudProviderAccessRole. @@ -66,7 +66,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 prettyprint format. * - --roleId - string - true @@ -93,13 +93,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 cloudProviderAccess getCloudProviderAccessRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleId [roleId] + atlas api cloudProviderAccess getCloudProviderAccessRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index c688b529..0a77f73d 100644 --- a/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles `Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Cloud-Provider-Access/operation/listCloudProviderAccessRoles. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 cloudProviderAccess listCloudProviderAccessRoles --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudProviderAccess listCloudProviderAccessRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index d3e6d18b..d5e7724e 100644 --- a/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -99,13 +99,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 clusterOutageSimulation endOutageSimulation --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusterOutageSimulation endOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index 4be16a03..0a66582a 100644 --- a/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 clusterOutageSimulation getOutageSimulation --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusterOutageSimulation getOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index dce25ff7..022dd71a 100644 --- a/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-autoScalingConfiguration.txt b/source/command/atlas-api-clusters-autoScalingConfiguration.txt index bbca117f..34654b65 100644 --- a/source/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/source/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 clusters autoScalingConfiguration --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters autoScalingConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-createCluster.txt b/source/command/atlas-api-clusters-createCluster.txt index c605cde8..47d7a8be 100644 --- a/source/command/atlas-api-clusters-createCluster.txt +++ b/source/command/atlas-api-clusters-createCluster.txt @@ -14,7 +14,7 @@ atlas api clusters createCluster `Public Preview: please provide feedback at `_: Creates one cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. +Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. @@ -73,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 prettyprint format. * - --version - string - false @@ -104,18 +104,18 @@ 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 ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2024-08-05_cluster - Cluster - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Cluster { "clusterType": "SHARDED", "name": "myCluster", @@ -219,23 +219,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-08-05 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Cluster + atlas api clusters createCluster --version 2024-08-05 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2024-10-23_cluster - Cluster - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Cluster { "clusterType": "SHARDED", "name": "myCluster", @@ -351,23 +351,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-10-23 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Cluster + atlas api clusters createCluster --version 2024-10-23 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Create a basic MongoDB Atlas cluster :tabid: 2024-10-23_create_cluster - Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 { "clusterType": "REPLICASET", "name": "MyCluster", @@ -391,11 +391,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-10-23 --file payload.json --envelope false --groupId [your-project-id] --pretty false + # Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 + atlas api clusters createCluster --version 2024-10-23 --file payload.json --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-deleteCluster.txt b/source/command/atlas-api-clusters-deleteCluster.txt index cd12d142..839725fb 100644 --- a/source/command/atlas-api-clusters-deleteCluster.txt +++ b/source/command/atlas-api-clusters-deleteCluster.txt @@ -14,7 +14,7 @@ atlas api clusters deleteCluster `Public Preview: please provide feedback at `_: Removes one cluster from the specified project. -The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. +The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. @@ -73,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 prettyprint format. * - --retainBackups - - false @@ -108,15 +108,12 @@ 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 ------------------ - - Deletes the specified cluster from the project - -Run the command below. +-------- .. code-block:: - atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Deletes the specified cluster from the project + atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getCluster.txt b/source/command/atlas-api-clusters-getCluster.txt index 33204d27..03a08701 100644 --- a/source/command/atlas-api-clusters-getCluster.txt +++ b/source/command/atlas-api-clusters-getCluster.txt @@ -14,7 +14,7 @@ atlas api clusters getCluster `Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. +Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. @@ -73,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 prettyprint format. * - --version - string - false @@ -96,15 +96,12 @@ 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 ------------------ - - Returns the details for the specified cluster in the project - -Run the command below. +-------- .. code-block:: - atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Returns the details for the specified cluster in the project + atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 507a1548..915cc5e5 100644 --- a/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -14,7 +14,7 @@ atlas api clusters getClusterAdvancedConfiguration `Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role. +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Clusters/operation/getClusterAdvancedConfiguration. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 clusters getClusterAdvancedConfiguration --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters getClusterAdvancedConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getClusterStatus.txt b/source/command/atlas-api-clusters-getClusterStatus.txt index c87a6b15..22f3f5ab 100644 --- a/source/command/atlas-api-clusters-getClusterStatus.txt +++ b/source/command/atlas-api-clusters-getClusterStatus.txt @@ -14,7 +14,7 @@ atlas api clusters getClusterStatus `Public Preview: please provide feedback at `_: Returns the status of all changes that you made to the specified cluster in the specified project. -Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. +Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Clusters/operation/getClusterStatus. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 9b0b9f60..c9501b55 100644 --- a/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -14,7 +14,7 @@ atlas api clusters getSampleDatasetLoadStatus `Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Clusters/operation/getSampleDatasetLoadStatus. @@ -89,13 +89,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 clusters getSampleDatasetLoadStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --sampleDatasetId [sampleDatasetId] + atlas api clusters getSampleDatasetLoadStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --sampleDatasetId [sampleDatasetId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index e170c3b0..3fcabc88 100644 --- a/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-listCloudProviderRegions.txt b/source/command/atlas-api-clusters-listCloudProviderRegions.txt index 943f5fed..1eced2a2 100644 --- a/source/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/source/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -14,7 +14,7 @@ atlas api clusters listCloudProviderRegions `Public Preview: please provide feedback at `_: Returns the list of regions available for the specified cloud provider at the specified tier. -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. 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/Clusters/operation/listCloudProviderRegions. @@ -78,7 +78,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 prettyprint format. * - --providers - stringArray - false @@ -109,13 +109,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 clusters listCloudProviderRegions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api clusters listCloudProviderRegions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-listClusters.txt b/source/command/atlas-api-clusters-listClusters.txt index 4d3cfa58..2f23e272 100644 --- a/source/command/atlas-api-clusters-listClusters.txt +++ b/source/command/atlas-api-clusters-listClusters.txt @@ -14,7 +14,7 @@ atlas api clusters listClusters `Public Preview: please provide feedback at `_: Returns the details for all clusters in the specific project to which you have access. -Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. +Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. @@ -85,7 +85,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 prettyprint format. * - --version - string - false @@ -108,15 +108,12 @@ 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 ------------------ - - Returns all clusters in the specified project - -Run the command below. +-------- .. code-block:: - atlas api clusters listClusters --version 2024-08-05 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns all clusters in the specified project + atlas api clusters listClusters --version 2024-08-05 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-listClustersForAllProjects.txt b/source/command/atlas-api-clusters-listClustersForAllProjects.txt index b4c9c967..177f14d4 100644 --- a/source/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/source/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -14,7 +14,7 @@ atlas api clusters listClustersForAllProjects `Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have access. -Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. +Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level 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/Clusters/operation/listClustersForAllProjects. @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -94,14 +94,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 clusters listClustersForAllProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-clusters-loadSampleDataset.txt b/source/command/atlas-api-clusters-loadSampleDataset.txt index a450cc39..fa3ed401 100644 --- a/source/command/atlas-api-clusters-loadSampleDataset.txt +++ b/source/command/atlas-api-clusters-loadSampleDataset.txt @@ -14,7 +14,7 @@ atlas api clusters loadSampleDataset `Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Clusters/operation/loadSampleDataset. @@ -97,13 +97,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 clusters loadSampleDataset --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] + atlas api clusters loadSampleDataset --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index cf7dd609..98a29b18 100644 --- a/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 3866a55c..38e46f47 100644 --- a/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 clusters revokeMongoDbEmployeeAccess --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters revokeMongoDbEmployeeAccess --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-testFailover.txt b/source/command/atlas-api-clusters-testFailover.txt index 5e0743a6..1eed3710 100644 --- a/source/command/atlas-api-clusters-testFailover.txt +++ b/source/command/atlas-api-clusters-testFailover.txt @@ -14,7 +14,7 @@ atlas api clusters testFailover `Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. +Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager 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/Clusters/operation/testFailover. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 clusters testFailover --version 2023-02-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters testFailover --version 2023-02-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 394a3a8e..1af714ab 100644 --- a/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 clusters unpinFeatureCompatibilityVersion --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters unpinFeatureCompatibilityVersion --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-updateCluster.txt b/source/command/atlas-api-clusters-updateCluster.txt index 8cc5ace9..e41b7eaf 100644 --- a/source/command/atlas-api-clusters-updateCluster.txt +++ b/source/command/atlas-api-clusters-updateCluster.txt @@ -14,7 +14,7 @@ atlas api clusters updateCluster `Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. +Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. 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/Clusters/operation/updateCluster. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -105,14 +105,13 @@ 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 ------------------ - - Updates the cluster to increase disk size to 20GB and increase node count to 5 +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Updates the cluster to increase disk size to 20GB and increase node count to 5 { "replicationSpecs": [ { @@ -133,11 +132,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Updates the cluster to increase disk size to 20GB and increase node count to 5 + atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index 4c520817..f09c0615 100644 --- a/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -14,7 +14,7 @@ atlas api clusters updateClusterAdvancedConfiguration `Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. -Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. 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/Clusters/operation/updateClusterAdvancedConfiguration. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-upgradeSharedCluster.txt b/source/command/atlas-api-clusters-upgradeSharedCluster.txt index f0fff163..ec15cbe9 100644 --- a/source/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/source/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -14,7 +14,7 @@ atlas api clusters upgradeSharedCluster `Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. -To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead. @@ -73,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 625e4f52..4dc2f510 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -115,13 +115,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 collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 905ffd55..841761e4 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,7 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace +`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. 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/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. @@ -111,13 +111,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 collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 6b0bd7dc..349d2468 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -83,13 +83,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 collectionLevelMetrics getCollStatsLatencyNamespaceMetrics --version 2023-11-15 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 74615c24..6f6dfb7d 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -103,13 +103,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 collectionLevelMetrics getCollStatsLatencyNamespacesForCluster --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H + atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --groupId 32b6e34b3d91647abb20e7b8 --period PT10H .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 2051790e..46307ae9 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -99,13 +99,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 collectionLevelMetrics getCollStatsLatencyNamespacesForHost --version 2023-11-15 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 + atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index c9471e81..821524ea 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -87,13 +87,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 collectionLevelMetrics getPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api collectionLevelMetrics getPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index fe13083c..7584710d 100644 --- a/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,7 +12,7 @@ atlas api collectionLevelMetrics unpinNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +`Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. 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/Collection-Level-Metrics/operation/unpinNamespaces. diff --git a/source/command/atlas-api-collectionLevelMetrics.txt b/source/command/atlas-api-collectionLevelMetrics.txt index b09f76ea..5ec03b98 100644 --- a/source/command/atlas-api-collectionLevelMetrics.txt +++ b/source/command/atlas-api-collectionLevelMetrics.txt @@ -52,18 +52,14 @@ Related Commands ---------------- * :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace - -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/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. * :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - `Public Preview: please provide feedback at `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. * :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - `Public Preview: please provide feedback at `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. * :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - `Public Preview: please provide feedback at `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. * :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - `Public Preview: please provide feedback at `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. * :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - `Public Preview: please provide feedback at `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. * :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `Public Preview: please provide feedback at `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster - -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/Collection-Level-Metrics/operation/unpinNamespaces. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. .. toctree:: diff --git a/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 5a6a2d33..b00105aa 100644 --- a/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles createCustomDatabaseRole `Public Preview: please provide feedback at `_: Creates one custom role in the specified project. -To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner 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/Custom-Database-Roles/operation/createCustomDatabaseRole. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 7377c485..efbe8822 100644 --- a/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole `Public Preview: please provide feedback at `_: Removes one custom role from the specified project. -You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. +You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner 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/Custom-Database-Roles/operation/deleteCustomDatabaseRole. @@ -66,7 +66,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 prettyprint format. * - --roleName - string - true @@ -93,13 +93,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 customDatabaseRoles deleteCustomDatabaseRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleName [roleName] + atlas api customDatabaseRoles deleteCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index fdfb1e6f..674d2779 100644 --- a/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles getCustomDatabaseRole `Public Preview: please provide feedback at `_: Returns one custom role for 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. 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/Custom-Database-Roles/operation/getCustomDatabaseRole. @@ -66,7 +66,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 prettyprint format. * - --roleName - string - true @@ -93,13 +93,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 customDatabaseRoles getCustomDatabaseRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleName [roleName] + atlas api customDatabaseRoles getCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 05e9f8fc..f2bafde3 100644 --- a/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles listCustomDatabaseRoles `Public Preview: please provide feedback at `_: Returns all custom roles for 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. 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/Custom-Database-Roles/operation/listCustomDatabaseRoles. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 customDatabaseRoles listCustomDatabaseRoles --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api customDatabaseRoles listCustomDatabaseRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index 34edb190..f4f8d847 100644 --- a/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles updateCustomDatabaseRole `Public Preview: please provide feedback at `_: Updates one custom role in the specified project. -To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner 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/Custom-Database-Roles/operation/updateCustomDatabaseRole. @@ -70,7 +70,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 prettyprint format. * - --roleName - string - true diff --git a/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index a7dce3a6..ce06fe53 100644 --- a/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -41,7 +41,7 @@ ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. -To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. 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/Data-Federation/operation/createDataFederationPrivateEndpoint. @@ -97,7 +97,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-dataFederation-createFederatedDatabase.txt b/source/command/atlas-api-dataFederation-createFederatedDatabase.txt index ffc23f5b..60f96562 100644 --- a/source/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation createFederatedDatabase `Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. 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/Data-Federation/operation/createFederatedDatabase. @@ -70,7 +70,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 prettyprint format. * - --skipRoleValidation - - false diff --git a/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index fd4a6ce7..af7204b1 100644 --- a/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation createOneDataFederationQueryLimit `Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Data-Federation/operation/createOneDataFederationQueryLimit. diff --git a/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index c525ec93..d066b72c 100644 --- a/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint `Public Preview: please provide feedback at `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Data-Federation/operation/deleteDataFederationPrivateEndpoint. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataFederation deleteDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation deleteDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index f950a5fa..2f60de68 100644 --- a/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteFederatedDatabase `Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. -To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. 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/Data-Federation/operation/deleteFederatedDatabase. @@ -66,7 +66,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 prettyprint format. * - --tenantName - string - true @@ -93,13 +93,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 dataFederation deleteFederatedDatabase --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api dataFederation deleteFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index f95bca18..643e2c81 100644 --- a/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit `Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit. @@ -101,13 +101,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 dataFederation deleteOneDataFederationInstanceQueryLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] + atlas api dataFederation deleteOneDataFederationInstanceQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index b4f744db..677f379d 100644 --- a/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -14,7 +14,7 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs `Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. -To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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/Data-Federation/operation/downloadFederatedDatabaseQueryLogs. @@ -93,9 +93,7 @@ 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:: diff --git a/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index 0e146393..4c3b54a9 100644 --- a/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api dataFederation getDataFederationPrivateEndpoint `Public Preview: please provide feedback at `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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/Data-Federation/operation/getDataFederationPrivateEndpoint. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataFederation getDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation getDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-getFederatedDatabase.txt b/source/command/atlas-api-dataFederation-getFederatedDatabase.txt index dfe9cde8..a20ad4de 100644 --- a/source/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation getFederatedDatabase `Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. -To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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/Data-Federation/operation/getFederatedDatabase. @@ -89,13 +89,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 dataFederation getFederatedDatabase --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api dataFederation getFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 78b70df0..268a1083 100644 --- a/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -14,7 +14,7 @@ atlas api dataFederation listDataFederationPrivateEndpoints `Public Preview: please provide feedback at `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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/Data-Federation/operation/listDataFederationPrivateEndpoints. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 dataFederation listDataFederationPrivateEndpoints --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api dataFederation listDataFederationPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-listFederatedDatabases.txt b/source/command/atlas-api-dataFederation-listFederatedDatabases.txt index 9818c85c..b6776ab6 100644 --- a/source/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/source/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -14,7 +14,7 @@ atlas api dataFederation listFederatedDatabases `Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. -To use this resource, the requesting API Key must have the Project Read Only or higher role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher 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/Data-Federation/operation/listFederatedDatabases. @@ -66,7 +66,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 prettyprint format. * - --type - string - false @@ -93,13 +93,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 dataFederation listFederatedDatabases --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation listFederatedDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index cb3fc95f..eabbd5a2 100644 --- a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit `Public Preview: please provide feedback at `_: Returns the details of one query limit for the specified federated database instance in 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. 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/Data-Federation/operation/returnFederatedDatabaseQueryLimit. @@ -78,7 +78,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 prettyprint format. * - --tenantName - string - true @@ -105,13 +105,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 dataFederation returnFederatedDatabaseQueryLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false --tenantName [tenantName] + atlas api dataFederation returnFederatedDatabaseQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 50c64292..d2f3cda7 100644 --- a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -14,7 +14,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits `Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in 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. 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/Data-Federation/operation/returnFederatedDatabaseQueryLimits. @@ -66,7 +66,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 prettyprint format. * - --tenantName - string - true @@ -93,13 +93,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 dataFederation returnFederatedDatabaseQueryLimits --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api dataFederation returnFederatedDatabaseQueryLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 9f1f2b2e..bd01f7c1 100644 --- a/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation updateFederatedDatabase `Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner or higher role. +To use this resource, the requesting Service Account or API Key must have the Project Owner or higher 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/Data-Federation/operation/updateFederatedDatabase. @@ -70,7 +70,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 prettyprint format. * - --skipRoleValidation - - true diff --git a/source/command/atlas-api-dataLakePipelines-deletePipeline.txt b/source/command/atlas-api-dataLakePipelines-deletePipeline.txt index 4693d9cf..db16f161 100644 --- a/source/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -95,13 +95,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 dataLakePipelines deletePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] + atlas api dataLakePipelines deletePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 3e133ec3..cd9440cf 100644 --- a/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 dataLakePipelines deletePipelineRunDataset --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataLakePipelines deletePipelineRunDataset --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-getPipeline.txt b/source/command/atlas-api-dataLakePipelines-getPipeline.txt index f44b59e3..bdde00ec 100644 --- a/source/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines getPipeline `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within 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. 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/Data-Lake-Pipelines/operation/getPipeline. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataLakePipelines getPipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines getPipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt index b3d5fab5..2e7fcf21 100644 --- a/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines getPipelineRun `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within 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. 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/Data-Lake-Pipelines/operation/getPipelineRun. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 dataLakePipelines getPipelineRun --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataLakePipelines getPipelineRun --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 4bb70934..54811976 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines listPipelineRuns `Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. -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. 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/Data-Lake-Pipelines/operation/listPipelineRuns. @@ -86,7 +86,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 prettyprint format. * - --version - string - false @@ -109,13 +109,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 dataLakePipelines listPipelineRuns --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineRuns --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index b314890c..f75225f3 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines listPipelineSchedules `Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -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. 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/Data-Lake-Pipelines/operation/listPipelineSchedules. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataLakePipelines listPipelineSchedules --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineSchedules --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index 831b4843..964e3da0 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines listPipelineSnapshots `Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -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. 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/Data-Lake-Pipelines/operation/listPipelineSnapshots. @@ -86,7 +86,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 prettyprint format. * - --version - string - false @@ -109,13 +109,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 dataLakePipelines listPipelineSnapshots --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineSnapshots --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelines.txt b/source/command/atlas-api-dataLakePipelines-listPipelines.txt index c7ae3928..57c6ec33 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines listPipelines `Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. -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. 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/Data-Lake-Pipelines/operation/listPipelines. @@ -85,13 +85,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 dataLakePipelines listPipelines --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api dataLakePipelines listPipelines --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-pausePipeline.txt b/source/command/atlas-api-dataLakePipelines-pausePipeline.txt index c3ee752b..d4ade077 100644 --- a/source/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines pausePipeline `Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within 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. 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/Data-Lake-Pipelines/operation/pausePipeline. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataLakePipelines pausePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines pausePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-resumePipeline.txt b/source/command/atlas-api-dataLakePipelines-resumePipeline.txt index 8dabc006..6caeaad4 100644 --- a/source/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -14,7 +14,7 @@ atlas api dataLakePipelines resumePipeline `Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within 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. 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/Data-Lake-Pipelines/operation/resumePipeline. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 dataLakePipelines resumePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines resumePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index f0d4c711..7615d831 100644 --- a/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-databaseUsers-createDatabaseUser.txt b/source/command/atlas-api-databaseUsers-createDatabaseUser.txt index 54f67837..b4fc2cf4 100644 --- a/source/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers createDatabaseUser `Public Preview: please provide feedback at `_: Creates one database user in the specified project. -This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. +This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner 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/Database-Users/operation/createDatabaseUser. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,18 +93,18 @@ 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 ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_aws_iam_authentication - AWS IAM Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS IAM Authentication { "awsIAMType": "USER", "databaseName": "$external", @@ -130,23 +130,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS IAM Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2023-01-01_ldap_authentication - LDAP Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # LDAP Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -172,23 +172,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # LDAP Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2023-01-01_oidc_workforce_federated_authentication - OIDC Workforce Federated Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # OIDC Workforce Federated Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -214,23 +214,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # OIDC Workforce Federated Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 3 :tabid: 2023-01-01_oidc_workload_federated_authentication - OIDC Workload Federated Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # OIDC Workload Federated Authentication { "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", @@ -256,23 +256,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # OIDC Workload Federated Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 4 :tabid: 2023-01-01_scram-sha_authentication - SCRAM-SHA Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # SCRAM-SHA Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -298,23 +298,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # SCRAM-SHA Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 5 :tabid: 2023-01-01_x509_authentication - X509 Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # X509 Authentication { "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", @@ -340,11 +340,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # X509 Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index f3144ec9..cabd212f 100644 --- a/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers deleteDatabaseUser `Public Preview: please provide feedback at `_: Removes one database user from the specified project. -To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner 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/Database-Users/operation/deleteDatabaseUser. @@ -70,14 +70,14 @@ 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 prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | @@ -110,13 +110,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 databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName + atlas api databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-getDatabaseUser.txt b/source/command/atlas-api-databaseUsers-getDatabaseUser.txt index 0ed568d6..79c21c35 100644 --- a/source/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers getDatabaseUser `Public Preview: please provide feedback at `_: Returns one database user that belong to 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. 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/Database-Users/operation/getDatabaseUser. @@ -70,14 +70,14 @@ 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 prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | @@ -110,13 +110,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 databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName + atlas api databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt index be04e97f..58b66964 100644 --- a/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -14,7 +14,7 @@ atlas api databaseUsers listDatabaseUsers `Public Preview: please provide feedback at `_: Returns all database users that belong to 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. 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/Database-Users/operation/listDatabaseUsers. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 databaseUsers listDatabaseUsers --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api databaseUsers listDatabaseUsers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 02454cac..491d11a0 100644 --- a/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers updateDatabaseUser `Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. -To use this resource, the requesting API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner 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/Database-Users/operation/updateDatabaseUser. @@ -74,14 +74,14 @@ 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 prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 8eb40a9d..bf3ddf8d 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 40f503bf..cd2b2a8d 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest `Public Preview: please provide feedback at `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. +MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. @@ -69,7 +69,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 prettyprint format. * - --version - string - false @@ -92,13 +92,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 encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 92adfca3..e5e25a22 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 8fe0cfdf..b4c34b66 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -80,7 +80,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 prettyprint format. * - --version - string - false @@ -103,13 +103,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 encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 3556e617..40a728e0 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index dc57b2de..7db00610 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest `Public Preview: please provide feedback at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. -MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. +MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. @@ -73,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-events-getOrganizationEvent.txt b/source/command/atlas-api-events-getOrganizationEvent.txt index bdf09323..d63dff1e 100644 --- a/source/command/atlas-api-events-getOrganizationEvent.txt +++ b/source/command/atlas-api-events-getOrganizationEvent.txt @@ -14,7 +14,7 @@ atlas api events getOrganizationEvent `Public Preview: please provide feedback at `_: Returns one event for the specified organization. -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return All Events from One Organization endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. @@ -51,7 +51,7 @@ Options * - --eventId - string - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the event that you want to return. * - -h, --help - - false @@ -75,7 +75,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 prettyprint format. * - --version - string - false @@ -98,13 +98,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 events getOrganizationEvent --version 2023-01-01 --envelope false --eventId [eventId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api events getOrganizationEvent --version 2023-01-01 --eventId [eventId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-getProjectEvent.txt b/source/command/atlas-api-events-getProjectEvent.txt index b8b5a87b..d0737b11 100644 --- a/source/command/atlas-api-events-getProjectEvent.txt +++ b/source/command/atlas-api-events-getProjectEvent.txt @@ -14,7 +14,7 @@ atlas api events getProjectEvent `Public Preview: please provide feedback at `_: Returns one event for the specified project. -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Events from One Project endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. @@ -51,7 +51,7 @@ Options * - --eventId - string - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the event that you want to return. * - --groupId - string - true @@ -77,7 +77,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 prettyprint format. * - --version - string - false @@ -100,13 +100,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 events getProjectEvent --version 2023-01-01 --envelope false --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api events getProjectEvent --version 2023-01-01 --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-listEventTypes.txt b/source/command/atlas-api-events-listEventTypes.txt index 3c2913fd..9299817a 100644 --- a/source/command/atlas-api-events-listEventTypes.txt +++ b/source/command/atlas-api-events-listEventTypes.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -92,14 +92,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 events listEventTypes --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-events-listOrganizationEvents.txt b/source/command/atlas-api-events-listOrganizationEvents.txt index 2f883572..0e33b9e0 100644 --- a/source/command/atlas-api-events-listOrganizationEvents.txt +++ b/source/command/atlas-api-events-listOrganizationEvents.txt @@ -14,7 +14,7 @@ atlas api events listOrganizationEvents `Public Preview: please provide feedback at `_: Returns all events for the specified organization. -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This resource remains under revision and may change. @@ -97,7 +97,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 prettyprint format. * - --version - string - false @@ -120,13 +120,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 events listOrganizationEvents --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api events listOrganizationEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-listProjectEvents.txt b/source/command/atlas-api-events-listProjectEvents.txt index 726aa9ef..ecc1e2e8 100644 --- a/source/command/atlas-api-events-listProjectEvents.txt +++ b/source/command/atlas-api-events-listProjectEvents.txt @@ -14,7 +14,7 @@ atlas api events listProjectEvents `Public Preview: please provide feedback at `_: Returns all events for the specified project. -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. +Events identify significant database, billing, or security activities or status changes. 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. @@ -109,7 +109,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 prettyprint format. * - --version - string - false @@ -132,13 +132,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 events listProjectEvents --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api events listProjectEvents --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index c1c66486..f97fd957 100644 --- a/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication createIdentityProvider `Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Note: This resource only supports the creation of OIDC identity providers. diff --git a/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 8a93dbdf..33000648 100644 --- a/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication createRoleMapping `Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Federated-Authentication/operation/createRoleMapping. diff --git a/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index ecb6614d..b8d99548 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication deleteFederationApp `Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. -To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. 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/Federated-Authentication/operation/deleteFederationApp. @@ -79,9 +79,7 @@ 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:: diff --git a/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index db78c5f0..e5f0518d 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -14,10 +14,10 @@ atlas api federatedAuthentication deleteIdentityProvider `Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see Manage Organization Mapping for Federated Authentication. +Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. 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/Federated-Authentication/operation/deleteIdentityProvider. @@ -90,13 +90,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 federatedAuthentication deleteIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index 225a7c73..e01faa7c 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication deleteRoleMapping `Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Federated-Authentication/operation/deleteRoleMapping. @@ -91,13 +91,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 federatedAuthentication deleteRoleMapping --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication deleteRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index b612f967..3040a1cf 100644 --- a/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getConnectedOrgConfig `Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in the connected org. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. 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/Federated-Authentication/operation/getConnectedOrgConfig. @@ -87,13 +87,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 federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt index c811ff41..aaa2cbe7 100644 --- a/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getFederationSettings `Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. -To use this resource, the requesting API Key must have the Organization Owner role in the connected org. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. 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/Federated-Authentication/operation/getFederationSettings. @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 federatedAuthentication getFederationSettings --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api federatedAuthentication getFederationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 6e08e04b..e6093977 100644 --- a/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getIdentityProvider `Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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/Federated-Authentication/operation/getIdentityProvider. @@ -87,13 +87,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 federatedAuthentication getIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 5167bc8b..e1c8b487 100644 --- a/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getIdentityProviderMetadata `Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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/Federated-Authentication/operation/getIdentityProviderMetadata. @@ -83,9 +83,7 @@ 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:: diff --git a/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt index be740768..ccdbebc2 100644 --- a/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getRoleMapping `Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Federated-Authentication/operation/getRoleMapping. @@ -91,13 +91,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 federatedAuthentication getRoleMapping --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication getRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index a7f64d7a..3440dc10 100644 --- a/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listConnectedOrgConfigs `Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. 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/Federated-Authentication/operation/listConnectedOrgConfigs. @@ -91,13 +91,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 federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1 + atlas api federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 2aa006a0..56d13846 100644 --- a/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listIdentityProviders `Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. -If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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/Federated-Authentication/operation/listIdentityProviders. @@ -99,13 +99,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 federatedAuthentication listIdentityProviders --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1 + atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 526eade3..8ca34bf1 100644 --- a/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listRoleMappings `Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Federated-Authentication/operation/listRoleMappings. @@ -87,13 +87,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 federatedAuthentication listRoleMappings --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication listRoleMappings --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index fd57c557..d4606cec 100644 --- a/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication removeConnectedOrgConfig `Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. 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/Federated-Authentication/operation/removeConnectedOrgConfig. @@ -87,13 +87,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 federatedAuthentication removeConnectedOrgConfig --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication removeConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 44dad211..a1ce6c88 100644 --- a/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -14,10 +14,10 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider `Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see Configure OIDC Authorization. +Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. 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/Federated-Authentication/operation/revokeJwksFromIdentityProvider. @@ -90,13 +90,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 federatedAuthentication revokeJwksFromIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication revokeJwksFromIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8f260a9a..5902f3c0 100644 --- a/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateConnectedOrgConfig `Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. diff --git a/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 18849857..fbff12d4 100644 --- a/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateIdentityProvider `Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. diff --git a/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 3cf7210f..4fc24923 100644 --- a/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateRoleMapping `Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Federated-Authentication/operation/updateRoleMapping. diff --git a/source/command/atlas-api-flexClusters-createFlexCluster.txt b/source/command/atlas-api-flexClusters-createFlexCluster.txt index 1cfb7808..522f77e5 100644 --- a/source/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-createFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters createFlexCluster `Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Clusters/operation/createFlexCluster. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexClusters-deleteFlexCluster.txt b/source/command/atlas-api-flexClusters-deleteFlexCluster.txt index 9c8e67c1..8a966a67 100644 --- a/source/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters deleteFlexCluster `Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. -The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. +The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Clusters/operation/deleteFlexCluster. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 flexClusters deleteFlexCluster --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api flexClusters deleteFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-getFlexCluster.txt b/source/command/atlas-api-flexClusters-getFlexCluster.txt index a47666ea..c91be2e6 100644 --- a/source/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-getFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters getFlexCluster `Public Preview: please provide feedback at `_: Returns details for one flex cluster in 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. 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/Flex-Clusters/operation/getFlexCluster. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 flexClusters getFlexCluster --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api flexClusters getFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-listFlexClusters.txt b/source/command/atlas-api-flexClusters-listFlexClusters.txt index 6294467e..ce50fd66 100644 --- a/source/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/source/command/atlas-api-flexClusters-listFlexClusters.txt @@ -14,7 +14,7 @@ atlas api flexClusters listFlexClusters `Public Preview: please provide feedback at `_: Returns details for all flex clusters in 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. 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/Flex-Clusters/operation/listFlexClusters. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 flexClusters listFlexClusters --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api flexClusters listFlexClusters --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-updateFlexCluster.txt b/source/command/atlas-api-flexClusters-updateFlexCluster.txt index 3dab221d..f128f5f1 100644 --- a/source/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters updateFlexCluster `Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Clusters/operation/updateFlexCluster. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 92d552ca..d0ca7624 100644 --- a/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters upgradeFlexCluster `Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. -To use this resource, the requesting API key must have the Project Cluster Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager 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/Flex-Clusters/operation/upgradeFlexCluster. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 1b720e6f..b1d2e217 100644 --- a/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob `Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 951e080e..0a18ea5f 100644 --- a/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob `Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob. @@ -70,7 +70,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 prettyprint format. * - --restoreJobId - string - true @@ -97,13 +97,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 flexRestoreJobs getFlexBackupRestoreJob --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false --restoreJobId [restoreJobId] + atlas api flexRestoreJobs getFlexBackupRestoreJob --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 6eded9c3..b40daadf 100644 --- a/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs `Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 flexRestoreJobs listFlexBackupRestoreJobs --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --name [name] --pageNum 1 --pretty false + atlas api flexRestoreJobs listFlexBackupRestoreJobs --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 1cd77d24..3ddafe01 100644 --- a/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots downloadFlexBackup `Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. -This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. +This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Flex-Snapshots/operation/downloadFlexBackup. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexSnapshots-getFlexBackup.txt b/source/command/atlas-api-flexSnapshots-getFlexBackup.txt index 48bc304e..9edd837f 100644 --- a/source/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/source/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots getFlexBackup `Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster 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. 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/Flex-Snapshots/operation/getFlexBackup. @@ -93,13 +93,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 flexSnapshots getFlexBackup --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --snapshotId 32b6e34b3d91647abb20e7b8 + atlas api flexSnapshots getFlexBackup --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --snapshotId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexSnapshots-listFlexBackups.txt b/source/command/atlas-api-flexSnapshots-listFlexBackups.txt index 3274df85..2a1a6443 100644 --- a/source/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/source/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots listFlexBackups `Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster 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. 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/Flex-Snapshots/operation/listFlexBackups. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 flexSnapshots listFlexBackups --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --name [name] --pageNum 1 --pretty false + atlas api flexSnapshots listFlexBackups --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 663f9100..50cf441e 100644 --- a/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -14,7 +14,7 @@ atlas api globalClusters createCustomZoneMapping `Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. -A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. +A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Global-Clusters/operation/createCustomZoneMapping. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-globalClusters-createManagedNamespace.txt b/source/command/atlas-api-globalClusters-createManagedNamespace.txt index e8c35432..fb5a17f2 100644 --- a/source/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters createManagedNamespace `Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. -A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Global-Clusters/operation/createManagedNamespace. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index c76e0ab8..5094f97e 100644 --- a/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -14,7 +14,7 @@ atlas api globalClusters deleteAllCustomZoneMappings `Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. -A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. +A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Global-Clusters/operation/deleteAllCustomZoneMappings. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 globalClusters deleteAllCustomZoneMappings --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters deleteAllCustomZoneMappings --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt index fef8c06f..a8e842dc 100644 --- a/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters deleteManagedNamespace `Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. -A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Global-Clusters/operation/deleteManagedNamespace. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 globalClusters deleteManagedNamespace --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters deleteManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters-getManagedNamespace.txt b/source/command/atlas-api-globalClusters-getManagedNamespace.txt index 9f8e5eef..69428c78 100644 --- a/source/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters getManagedNamespace `Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. -A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role. +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Global-Clusters/operation/getManagedNamespace. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 globalClusters getManagedNamespace --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters getManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-downloadInvoiceCsv.txt b/source/command/atlas-api-invoices-downloadInvoiceCsv.txt index e74bb628..0dcd135f 100644 --- a/source/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/source/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -14,7 +14,7 @@ atlas api invoices downloadInvoiceCsv `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. -A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. +A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. 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/Invoices/operation/downloadInvoiceCsv. @@ -69,7 +69,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 prettyprint format. * - --version - string - false @@ -92,13 +92,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 invoices downloadInvoiceCsv --version 2023-01-01 --envelope false --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices downloadInvoiceCsv --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 35d0dd0f..1afd7a1c 100644 --- a/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -87,13 +87,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 invoices getCostExplorerQueryProcess --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --token 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C + atlas api invoices getCostExplorerQueryProcess --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --token 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-getInvoice.txt b/source/command/atlas-api-invoices-getInvoice.txt index b2ae85ee..79398cda 100644 --- a/source/command/atlas-api-invoices-getInvoice.txt +++ b/source/command/atlas-api-invoices-getInvoice.txt @@ -14,7 +14,7 @@ atlas api invoices getInvoice `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. -A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. +A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. 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/Invoices/operation/getInvoice. @@ -69,7 +69,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 prettyprint format. * - --version - string - false @@ -92,13 +92,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 invoices getInvoice --version 2023-01-01 --envelope false --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices getInvoice --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-listInvoices.txt b/source/command/atlas-api-invoices-listInvoices.txt index ada81e0e..ef5206c1 100644 --- a/source/command/atlas-api-invoices-listInvoices.txt +++ b/source/command/atlas-api-invoices-listInvoices.txt @@ -14,7 +14,7 @@ atlas api invoices listInvoices `Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. -This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. +This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. 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/Invoices/operation/listInvoices. @@ -85,7 +85,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 prettyprint format. * - --sortBy - string - false @@ -124,13 +124,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 invoices listInvoices --version 2023-01-01 --envelope false --fromDate 2023-01-01 --includeCount true --itemsPerPage 100 --orderBy desc --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false --toDate 2023-01-01 + atlas api invoices listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-listPendingInvoices.txt b/source/command/atlas-api-invoices-listPendingInvoices.txt index e21a4bf1..36f2f424 100644 --- a/source/command/atlas-api-invoices-listPendingInvoices.txt +++ b/source/command/atlas-api-invoices-listPendingInvoices.txt @@ -14,7 +14,7 @@ atlas api invoices listPendingInvoices `Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. -To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. +To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner 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/Invoices/operation/listPendingInvoices. @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 invoices listPendingInvoices --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices listPendingInvoices --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 30d8689e..82b6c2e2 100644 --- a/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration deleteLdapConfiguration `Public Preview: please provide feedback at `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/LDAP-Configuration/operation/deleteLdapConfiguration. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 ldapConfiguration deleteLdapConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api ldapConfiguration deleteLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index e74648b2..67ebae84 100644 --- a/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration getLdapConfiguration `Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/LDAP-Configuration/operation/getLdapConfiguration. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 ldapConfiguration getLdapConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api ldapConfiguration getLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 669cb6bd..fed08167 100644 --- a/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration getLdapConfigurationStatus `Public Preview: please provide feedback at `_: Returns the status of one request to verify one LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/LDAP-Configuration/operation/getLdapConfigurationStatus. @@ -66,11 +66,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 prettyprint format. * - --requestId - string - true - - Unique string that identifies the request to verify an LDAP configuration. + - Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration. * - --version - string - false @@ -93,13 +93,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 ldapConfiguration getLdapConfigurationStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --requestId [requestId] + atlas api ldapConfiguration getLdapConfigurationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --requestId [requestId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index b3e0f5d5..abff9b36 100644 --- a/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration saveLdapConfiguration `Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. @@ -73,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index ef48dbcc..27b107c1 100644 --- a/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration verifyLdapConfiguration `Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/LDAP-Configuration/operation/verifyLdapConfiguration. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 60af752b..b9ca9479 100644 --- a/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api legacyBackup createLegacyBackupRestoreJob `Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. 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/Legacy-Backup/operation/createLegacyBackupRestoreJob. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 7c304b71..1a4c92cc 100644 --- a/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -14,7 +14,7 @@ atlas api legacyBackup deleteLegacySnapshot `Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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/Legacy-Backup/operation/deleteLegacySnapshot. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -97,13 +97,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 legacyBackup deleteLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api legacyBackup deleteLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index a5835f05..fb60d17f 100644 --- a/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacyBackupCheckpoint `Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in 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. 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/Legacy-Backup/operation/getLegacyBackupCheckpoint. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 legacyBackup getLegacyBackupCheckpoint --version 2023-01-01 --checkpointId [checkpointId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api legacyBackup getLegacyBackupCheckpoint --version 2023-01-01 --checkpointId [checkpointId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 33026509..271a1871 100644 --- a/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacyBackupRestoreJob `Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in 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. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -77,7 +77,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 prettyprint format. * - --version - string - false @@ -100,13 +100,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 legacyBackup getLegacyBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] --pretty false + atlas api legacyBackup getLegacyBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt index b0d1b460..20d32844 100644 --- a/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacySnapshot `Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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/Legacy-Backup/operation/getLegacySnapshot. @@ -70,7 +70,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 prettyprint format. * - --snapshotId - string - true @@ -97,13 +97,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 legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 35cb0162..b1d5d1c6 100644 --- a/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacySnapshotSchedule `Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in 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. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -73,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 prettyprint format. * - --version - string - false @@ -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 legacyBackup getLegacySnapshotSchedule --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api legacyBackup getLegacySnapshotSchedule --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 7bdd6357..457c2f01 100644 --- a/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacyBackupCheckpoints `Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in 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. 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/Legacy-Backup/operation/listLegacyBackupCheckpoints. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 legacyBackup listLegacyBackupCheckpoints --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacyBackupCheckpoints --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index 67568508..6641a0a2 100644 --- a/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacyBackupRestoreJobs `Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in 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. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. @@ -89,7 +89,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 prettyprint format. * - --version - string - false @@ -112,13 +112,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 legacyBackup listLegacyBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacyBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt index f69edb5a..f5d81ad7 100644 --- a/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacySnapshots `Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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/Legacy-Backup/operation/listLegacySnapshots. @@ -86,7 +86,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 prettyprint format. * - --version - string - false @@ -109,13 +109,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 legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index ef11c09c..8f66b9e9 100644 --- a/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -14,7 +14,7 @@ atlas api legacyBackup updateLegacySnapshotRetention `Public Preview: please provide feedback at `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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/Legacy-Backup/operation/updateLegacySnapshotRetention. @@ -74,7 +74,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 prettyprint format. * - --snapshotId - string - true diff --git a/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 3a8f3cbc..93257b32 100644 --- a/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -14,7 +14,7 @@ atlas api legacyBackup updateLegacySnapshotSchedule `Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index 5ec6bc27..d6fbd3cc 100644 --- a/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows deferMaintenanceWindow `Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. -Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. +Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Maintenance-Windows/operation/deferMaintenanceWindow. @@ -85,13 +85,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 maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 864b07e3..bf2fb78f 100644 --- a/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows getMaintenanceWindow `Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. -MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. +MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Maintenance-Windows/operation/getMaintenanceWindow. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 maintenanceWindows getMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api maintenanceWindows getMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 51ff5d2f..a8d27d6e 100644 --- a/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows resetMaintenanceWindow `Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Maintenance-Windows/operation/resetMaintenanceWindow. @@ -85,13 +85,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 maintenanceWindows resetMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows resetMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 1323a7ca..a11008ec 100644 --- a/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer `Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Maintenance-Windows/operation/toggleMaintenanceAutoDefer. @@ -85,13 +85,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 maintenanceWindows toggleMaintenanceAutoDefer --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows toggleMaintenanceAutoDefer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index cbd70725..7e3133ab 100644 --- a/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows updateMaintenanceWindow `Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. -Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. +Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Maintenance-Windows/operation/updateMaintenanceWindow. diff --git a/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index 910eada7..953b7e7f 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addOrganizationRole `Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. -You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This operation is atomic. @@ -74,7 +74,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 37e5f313..3924bb9d 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addProjectRole `Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. -You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting API Key must have the Project Owner role. +You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -73,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 9f742f35..8885fd69 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addProjectUser `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -80,7 +80,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 038b954d..8f91ef7f 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addUserToTeam `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. -You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -71,7 +71,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 prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index c956c043..015cfcb1 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers createOrganizationUser `Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. -The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. +The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. @@ -71,7 +71,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-createUser.txt b/source/command/atlas-api-mongoDbCloudUsers-createUser.txt index c4a61ad2..38574fce 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -20,7 +20,7 @@ A MongoDB Cloud user account grants access to only the MongoDB Cloud application MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. -To use this resource, the requesting API Key can have any role. +To use this resource, the requesting Service Account or API Key can have any 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/MongoDB-Cloud-Users/operation/createUser. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 5b1d9250..f7ec1569 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getOrganizationUser `Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member role. Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. @@ -70,7 +70,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 prettyprint format. * - --userId - string - true @@ -97,13 +97,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 mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --userId [userId] + atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 4ec13f06..c3b044f8 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getProjectUser `Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of 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. Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. @@ -72,7 +72,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 prettyprint format. * - --userId - string - true @@ -99,13 +99,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 mongoDbCloudUsers getProjectUser --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --userId [userId] + atlas api mongoDbCloudUsers getProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-getUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getUser.txt index 59634d9f..0ffe4155 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getUser `Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. +You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any 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/MongoDB-Cloud-Users/operation/getUser. @@ -60,7 +60,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 prettyprint format. * - --userId - string - true @@ -86,14 +86,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 mongoDbCloudUsers getUser --version 2023-01-01 --envelope false --pretty false --userId [userId] - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 85617340..6b6ecdf9 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getUserByUsername `Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. -You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting API Key can have any role. +You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any 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/MongoDB-Cloud-Users/operation/getUserByUsername. @@ -60,7 +60,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 prettyprint format. * - --userName - string - true @@ -86,14 +86,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 mongoDbCloudUsers getUserByUsername --version 2023-01-01 --envelope false --pretty false --userName [userName] - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 38b61659..6c4274f0 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listOrganizationUsers `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member role. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -86,7 +86,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 prettyprint format. * - --username - string - false @@ -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 mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false + atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index eefeb367..91256d2f 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listProjectUsers `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with 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. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -96,7 +96,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 prettyprint format. * - --username - string - false @@ -123,13 +123,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 mongoDbCloudUsers listProjectUsers --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false + atlas api mongoDbCloudUsers listProjectUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 69bcb6fe..f5513515 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listTeamUsers `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. +Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -82,7 +82,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 prettyprint format. * - --teamId - string - true @@ -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 mongoDbCloudUsers listTeamUsers --version 2025-02-19 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false --teamId [teamId] + atlas api mongoDbCloudUsers listTeamUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 18fd956f..758f2702 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeOrganizationRole `Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. -You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. +You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This operation is atomic. @@ -74,7 +74,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index 7d43c9f4..1ca12c9d 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeOrganizationUser `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -70,7 +70,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 prettyprint format. * - --userId - string - true @@ -97,13 +97,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 mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --userId [userId] + atlas api mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 36703b70..42145993 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeProjectRole `Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. -You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Project Owner role. +You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -73,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index 9566e94d..791ae1bf 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeProjectUser `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Project Owner role. +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -72,7 +72,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 prettyprint format. * - --userId - string - true @@ -99,13 +99,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 mongoDbCloudUsers removeProjectUser --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --userId [userId] + atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 51dd80ed..fdfe1fea 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeUserFromTeam `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -71,7 +71,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 prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index ed4710b6..8078f727 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers updateOrganizationUser `Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. -You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. @@ -74,7 +74,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index eaa9cf21..07255a41 100644 --- a/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getAtlasProcess `Public Preview: please provide feedback at `_: Returns the processes for the specified host for 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. 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/Monitoring-and-Logs/operation/getAtlasProcess. @@ -66,7 +66,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 prettyprint format. * - --processId - mongod - true @@ -93,13 +93,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 monitoringAndLogs getAtlasProcess --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getAtlasProcess --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDatabase.txt b/source/command/atlas-api-monitoringAndLogs-getDatabase.txt index 25498897..12765a71 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getDatabase `Public Preview: please provide feedback at `_: Returns one database running on the specified host for 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. 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/Monitoring-and-Logs/operation/getDatabase. @@ -70,7 +70,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 prettyprint format. * - --processId - mongod - true @@ -97,13 +97,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 monitoringAndLogs getDatabase --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDatabase --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 7791030e..efbad3f3 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getDatabaseMeasurements `Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. -Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. +Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Monitoring-and-Logs/operation/getDatabaseMeasurements. @@ -86,7 +86,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 prettyprint format. * - --processId - mongod - true @@ -117,13 +117,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 monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index e530fc6f..f7dc6de3 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -31,7 +31,7 @@ Amount of free and used disk space on the disk partition used for the MongoDB pr -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. 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/Monitoring-and-Logs/operation/getDiskMeasurements. @@ -103,7 +103,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 prettyprint format. * - --processId - mongod - true @@ -134,13 +134,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 monitoringAndLogs getDiskMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDiskMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt index 01e2f01c..d6dca449 100644 --- a/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getHostLogs `Public Preview: please provide feedback at `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". +MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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/Monitoring-and-Logs/operation/getHostLogs. @@ -101,15 +101,12 @@ 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 ------------------ - - Returns a compressed (.gz) MongoDB log file containing log messages for the specified host - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --envelope false --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200 + # Returns a compressed (.gz) MongoDB log file containing log messages for the specified host + atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index ebb68a76..36afa588 100644 --- a/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -34,7 +34,7 @@ Measurements for the host, such as CPU usage or number of I/O operations -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. 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/Monitoring-and-Logs/operation/getHostMeasurements. @@ -102,7 +102,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 prettyprint format. * - --processId - mongod - true @@ -133,13 +133,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 monitoringAndLogs getHostMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getHostMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index cb33faa0..54a58009 100644 --- a/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -121,13 +121,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 monitoringAndLogs getIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --indexName myindex --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs getIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --indexName myindex --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 2854e1c3..daf0501f 100644 --- a/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -109,13 +109,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 monitoringAndLogs getMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs getMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 59aad384..625ecb1b 100644 --- a/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listAtlasProcesses `Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. -A MongoDB process can be either a mongod or mongos. To use this resource, the requesting API Key must have the Project Read Only role. +A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Monitoring-and-Logs/operation/listAtlasProcesses. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,15 +101,12 @@ 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 ------------------ - - Returns details of all processes for the specified project - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listAtlasProcesses --version 2023-01-01 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns details of all processes for the specified project + atlas api monitoringAndLogs listAtlasProcesses --version 2023-01-01 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDatabases.txt b/source/command/atlas-api-monitoringAndLogs-listDatabases.txt index f9b16c33..efb49557 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDatabases `Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. -M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting API Key must have the Project Read Only role. +M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Monitoring-and-Logs/operation/listDatabases. @@ -78,7 +78,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 prettyprint format. * - --processId - mongod - true @@ -105,13 +105,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 monitoringAndLogs listDatabases --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index dfbbbce8..a6a817b1 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDiskMeasurements `Public Preview: please provide feedback at `_: Returns measurement details for one disk or partition for the specified host for 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. 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/Monitoring-and-Logs/operation/listDiskMeasurements. @@ -93,13 +93,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 monitoringAndLogs listDiskMeasurements --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDiskMeasurements --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 348a3dba..3d085fea 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDiskPartitions `Public Preview: please provide feedback at `_: Returns the list of disks or partitions for the specified host for 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. 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/Monitoring-and-Logs/operation/listDiskPartitions. @@ -78,7 +78,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 prettyprint format. * - --processId - mongod - true @@ -105,13 +105,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 monitoringAndLogs listDiskPartitions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDiskPartitions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 7da6fcb3..fceaa080 100644 --- a/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -115,13 +115,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 monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index e49a3a76..70f4a0fb 100644 --- a/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -89,13 +89,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 monitoringAndLogs listMetricTypes --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017 + atlas api monitoringAndLogs listMetricTypes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-createPeeringConnection.txt b/source/command/atlas-api-networkPeering-createPeeringConnection.txt index 5c1debcb..63109c45 100644 --- a/source/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering createPeeringConnection `Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. -Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. 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/Network-Peering/operation/createPeeringConnection. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-createPeeringContainer.txt b/source/command/atlas-api-networkPeering-createPeeringContainer.txt index 7fc87d13..4869499b 100644 --- a/source/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering createPeeringContainer `Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. -MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role. +MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/createPeeringContainer. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-deletePeeringConnection.txt b/source/command/atlas-api-networkPeering-deletePeeringConnection.txt index 57382439..5ba4ecf9 100644 --- a/source/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering deletePeeringConnection `Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. -If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. +If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/deletePeeringConnection. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 networkPeering deletePeeringConnection --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] --pretty false + atlas api networkPeering deletePeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-deletePeeringContainer.txt b/source/command/atlas-api-networkPeering-deletePeeringContainer.txt index 8728d32c..3639b570 100644 --- a/source/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering deletePeeringContainer `Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/deletePeeringContainer. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 networkPeering deletePeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering deletePeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-disablePeering.txt b/source/command/atlas-api-networkPeering-disablePeering.txt index 8c5f6ae7..86202a80 100644 --- a/source/command/atlas-api-networkPeering-disablePeering.txt +++ b/source/command/atlas-api-networkPeering-disablePeering.txt @@ -14,7 +14,7 @@ atlas api networkPeering disablePeering `Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/disablePeering. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-getPeeringConnection.txt b/source/command/atlas-api-networkPeering-getPeeringConnection.txt index 3f521e24..2c63de7b 100644 --- a/source/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering getPeeringConnection `Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in 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. 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/Network-Peering/operation/getPeeringConnection. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 networkPeering getPeeringConnection --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] --pretty false + atlas api networkPeering getPeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-getPeeringContainer.txt b/source/command/atlas-api-networkPeering-getPeeringContainer.txt index 4f198706..97e4a89c 100644 --- a/source/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering getPeeringContainer `Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. -Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Network-Peering/operation/getPeeringContainer. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 networkPeering getPeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering getPeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringConnections.txt b/source/command/atlas-api-networkPeering-listPeeringConnections.txt index 4d6e0837..fdb92489 100644 --- a/source/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/source/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringConnections `Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. -Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Network-Peering/operation/listPeeringConnections. @@ -78,7 +78,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 prettyprint format. * - --providerName - string - false @@ -105,13 +105,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 networkPeering listPeeringConnections --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api networkPeering listPeeringConnections --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 1fde76c9..15a1b127 100644 --- a/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringContainerByCloudProvider `Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project for the specified cloud provider. -If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. +If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Network-Peering/operation/listPeeringContainerByCloudProvider. @@ -78,7 +78,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 prettyprint format. * - --providerName - string - true @@ -105,13 +105,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 networkPeering listPeeringContainerByCloudProvider --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --providerName [providerName] + atlas api networkPeering listPeeringContainerByCloudProvider --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --providerName [providerName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringContainers.txt b/source/command/atlas-api-networkPeering-listPeeringContainers.txt index d04c5554..afd87d3f 100644 --- a/source/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/source/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringContainers `Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. -Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Network-Peering/operation/listPeeringContainers. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 networkPeering listPeeringContainers --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api networkPeering listPeeringContainers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-updatePeeringConnection.txt b/source/command/atlas-api-networkPeering-updatePeeringConnection.txt index 0db37a00..dfaea82e 100644 --- a/source/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering updatePeeringConnection `Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/updatePeeringConnection. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-updatePeeringContainer.txt b/source/command/atlas-api-networkPeering-updatePeeringContainer.txt index 75d92063..7a6c0fc7 100644 --- a/source/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering updatePeeringContainer `Public Preview: please provide feedback at `_: Updates the network details and labels of one specified network peering container in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Network-Peering/operation/updatePeeringContainer. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 923dd610..a7c7523b 100644 --- a/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -14,7 +14,7 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject `Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. -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. 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/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 networkPeering verifyConnectViaPeeringOnlyModeForOneProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-createOnlineArchive.txt b/source/command/atlas-api-onlineArchive-createOnlineArchive.txt index 486412d8..01d4ec90 100644 --- a/source/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive createOnlineArchive `Public Preview: please provide feedback at `_: Creates one online archive. -This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Online-Archive/operation/createOnlineArchive. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index debd95db..cc6b2bde 100644 --- a/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive deleteOnlineArchive `Public Preview: please provide feedback at `_: Removes one online archive. -This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Online-Archive/operation/deleteOnlineArchive. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 onlineArchive deleteOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api onlineArchive deleteOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 33da882b..7fd500b8 100644 --- a/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -14,7 +14,7 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs `Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. -To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". +To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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/Online-Archive/operation/downloadOnlineArchiveQueryLogs. @@ -101,13 +101,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 onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09 + atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-getOnlineArchive.txt b/source/command/atlas-api-onlineArchive-getOnlineArchive.txt index 53544785..1ce49420 100644 --- a/source/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive getOnlineArchive `Public Preview: please provide feedback at `_: Returns one online archive for one cluster. -This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Online-Archive/operation/getOnlineArchive. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 onlineArchive getOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api onlineArchive getOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-listOnlineArchives.txt b/source/command/atlas-api-onlineArchive-listOnlineArchives.txt index 486285c0..6afde4bd 100644 --- a/source/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/source/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -14,7 +14,7 @@ atlas api onlineArchive listOnlineArchives `Public Preview: please provide feedback at `_: Returns details of all online archives. -This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Online-Archive/operation/listOnlineArchives. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 onlineArchive listOnlineArchives --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api onlineArchive listOnlineArchives --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt index abe2700b..0ec8caa2 100644 --- a/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive updateOnlineArchive `Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. -This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Online-Archive/operation/updateOnlineArchive. @@ -78,7 +78,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-createOrganization.txt b/source/command/atlas-api-organizations-createOrganization.txt index 625d657d..98a3125a 100644 --- a/source/command/atlas-api-organizations-createOrganization.txt +++ b/source/command/atlas-api-organizations-createOrganization.txt @@ -12,9 +12,9 @@ atlas api organizations createOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +`Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. -To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. 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/Organizations/operation/createOrganization. @@ -64,7 +64,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-createOrganizationInvitation.txt b/source/command/atlas-api-organizations-createOrganizationInvitation.txt index 6b26ca76..4fdfe787 100644 --- a/source/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations createOrganizationInvitation `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. -The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. +The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user. @@ -71,7 +71,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-deleteOrganization.txt b/source/command/atlas-api-organizations-deleteOrganization.txt index 86c5567b..339a5310 100644 --- a/source/command/atlas-api-organizations-deleteOrganization.txt +++ b/source/command/atlas-api-organizations-deleteOrganization.txt @@ -22,7 +22,7 @@ Organizations with active projects cannot be removed. All projects in the organization must be removed before you can remove the organization. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Organizations/operation/deleteOrganization. @@ -91,13 +91,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 organizations deleteOrganization --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 + atlas api organizations deleteOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 0968741c..a5286d80 100644 --- a/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations deleteOrganizationInvitation `Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user. @@ -71,7 +71,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 prettyprint format. * - --version - string - false @@ -94,13 +94,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 organizations deleteOrganizationInvitation --version 2023-01-01 --envelope false --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations deleteOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganization.txt b/source/command/atlas-api-organizations-getOrganization.txt index 27b3639e..5a282570 100644 --- a/source/command/atlas-api-organizations-getOrganization.txt +++ b/source/command/atlas-api-organizations-getOrganization.txt @@ -12,9 +12,9 @@ atlas api organizations getOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization to which the requesting API key has access. +`Public Preview: please provide feedback at `_: Returns one organization to which the requesting Service Account or API Key has access. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Organizations/operation/getOrganization. @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 organizations getOrganization --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations getOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganizationInvitation.txt b/source/command/atlas-api-organizations-getOrganizationInvitation.txt index 964a9eda..952027fd 100644 --- a/source/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations getOrganizationInvitation `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. @@ -90,13 +90,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 organizations getOrganizationInvitation --version 2023-01-01 --envelope false --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 + atlas api organizations getOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganizationSettings.txt b/source/command/atlas-api-organizations-getOrganizationSettings.txt index 422cd524..b7dc2001 100644 --- a/source/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/source/command/atlas-api-organizations-getOrganizationSettings.txt @@ -14,7 +14,7 @@ atlas api organizations getOrganizationSettings `Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Organizations/operation/getOrganizationSettings. @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 organizations getOrganizationSettings --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations getOrganizationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizationInvitations.txt b/source/command/atlas-api-organizations-listOrganizationInvitations.txt index a96192e5..3d2a7d35 100644 --- a/source/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/source/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -14,7 +14,7 @@ atlas api organizations listOrganizationInvitations `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. @@ -67,7 +67,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 prettyprint format. * - --username - string - false @@ -94,13 +94,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 organizations listOrganizationInvitations --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations listOrganizationInvitations --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizationProjects.txt b/source/command/atlas-api-organizations-listOrganizationProjects.txt index 1a4da7f4..7117b60c 100644 --- a/source/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/source/command/atlas-api-organizations-listOrganizationProjects.txt @@ -31,7 +31,7 @@ Create different alert settings. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Organizations/operation/listOrganizationProjects. @@ -97,7 +97,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 prettyprint format. * - --version - string - false @@ -120,13 +120,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 organizations listOrganizationProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api organizations listOrganizationProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizations.txt b/source/command/atlas-api-organizations-listOrganizations.txt index 83fe2ceb..84addc85 100644 --- a/source/command/atlas-api-organizations-listOrganizations.txt +++ b/source/command/atlas-api-organizations-listOrganizations.txt @@ -12,9 +12,9 @@ atlas api organizations listOrganizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organizations to which the requesting API Key has access. +`Public Preview: please provide feedback at `_: Returns all organizations to which the requesting Service Account or API Key has access. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Organizations/operation/listOrganizations. @@ -76,7 +76,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 prettyprint format. * - --version - string - false @@ -98,14 +98,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 organizations listOrganizations --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-organizations-updateOrganization.txt b/source/command/atlas-api-organizations-updateOrganization.txt index b373ad69..9ec5d73c 100644 --- a/source/command/atlas-api-organizations-updateOrganization.txt +++ b/source/command/atlas-api-organizations-updateOrganization.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganization `Public Preview: please provide feedback at `_: Updates one organization. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Organizations/operation/updateOrganization. @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationInvitation.txt b/source/command/atlas-api-organizations-updateOrganizationInvitation.txt index 4dae35d9..2b7a6e05 100644 --- a/source/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 2ad58f8b..5f8bcf48 100644 --- a/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationRoles.txt b/source/command/atlas-api-organizations-updateOrganizationRoles.txt index 88afb48c..cba01310 100644 --- a/source/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/source/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationRoles `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. -To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User 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/Organizations/operation/updateOrganizationRoles. @@ -68,7 +68,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-organizations-updateOrganizationSettings.txt b/source/command/atlas-api-organizations-updateOrganizationSettings.txt index 65d220f6..31799f08 100644 --- a/source/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/source/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationSettings `Public Preview: please provide feedback at `_: Updates the organization's settings. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Organizations/operation/updateOrganizationSettings. @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations.txt b/source/command/atlas-api-organizations.txt index 1c3864d4..8d12bcb6 100644 --- a/source/command/atlas-api-organizations.txt +++ b/source/command/atlas-api-organizations.txt @@ -49,16 +49,16 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. * :ref:`atlas-api-organizations-createOrganizationInvitation` - `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. * :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback at `_: Removes one specified organization. * :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - `Public Preview: please provide feedback at `_: Returns one organization to which the requesting API key has access. +* :ref:`atlas-api-organizations-getOrganization` - `Public Preview: please provide feedback at `_: Returns one organization to which the requesting Service Account or API Key has access. * :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. * :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. * :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. * :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback at `_: Returns all organizations to which the requesting API Key has access. +* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback at `_: Returns all organizations to which the requesting Service Account or API Key has access. * :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback at `_: Updates one organization. * :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. * :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. diff --git a/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index cf00ef2e..872e6ae2 100644 --- a/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor disableSlowOperationThresholding `Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Performance-Advisor/operation/disableSlowOperationThresholding. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 performanceAdvisor disableSlowOperationThresholding --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor disableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 22b7e990..d8a72249 100644 --- a/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor enableSlowOperationThresholding `Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Performance-Advisor/operation/enableSlowOperationThresholding. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 performanceAdvisor enableSlowOperationThresholding --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor enableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 7f756cd8..b75d6128 100644 --- a/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 performanceAdvisor getManagedSlowMs --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor getManagedSlowMs --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index bdb939b9..158e0446 100644 --- a/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 performanceAdvisor getServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor getServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 2000dbdb..9debdcda 100644 --- a/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listClusterSuggestedIndexes `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Performance-Advisor/operation/listClusterSuggestedIndexes. @@ -58,7 +58,7 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. * - --output - string - false @@ -107,9 +107,7 @@ 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:: diff --git a/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 8d083ed9..a8edc15d 100644 --- a/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listDropIndexes `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. -The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting API Key must have the Project Read Only role. +The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Performance-Advisor/operation/listDropIndexes. @@ -85,9 +85,7 @@ 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:: diff --git a/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 70b85b06..0ae5af7c 100644 --- a/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSchemaAdvice `Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. -The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting API Key must have the Project Read Only role. +The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Performance-Advisor/operation/listSchemaAdvice. @@ -85,9 +85,7 @@ 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:: diff --git a/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt index f6fca426..732604ac 100644 --- a/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSlowQueries `Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have any Project Data Access role or the Project Observability Viewer role. +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer 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/Performance-Advisor/operation/listSlowQueries. @@ -69,7 +69,7 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + - Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. * - --output - string - false @@ -81,7 +81,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 prettyprint format. * - --processId - mongod - true @@ -115,13 +115,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 performanceAdvisor listSlowQueries --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId [processId] + atlas api performanceAdvisor listSlowQueries --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index 03708bb5..f320d272 100644 --- a/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSlowQueryNamespaces `Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. +If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Performance-Advisor/operation/listSlowQueryNamespaces. @@ -73,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 prettyprint format. * - --processId - mongod - true @@ -107,13 +107,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 performanceAdvisor listSlowQueryNamespaces --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId [processId] + atlas api performanceAdvisor listSlowQueryNamespaces --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index a56189a2..46368cd5 100644 --- a/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSuggestedIndexes `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Performance-Advisor/operation/listSuggestedIndexes. @@ -81,7 +81,7 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. * - --output - string - false @@ -97,7 +97,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 prettyprint format. * - --processId - mongod - true @@ -131,13 +131,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 performanceAdvisor listSuggestedIndexes --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId [processId] + atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index a6e39d7a..f2b2dfff 100644 --- a/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 performanceAdvisor setServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --enable [enable] --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor setServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --enable [enable] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 6928a2d9..e4f0dc6b 100644 --- a/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices createPrivateEndpoint `Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. -This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. +This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. 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/Private-Endpoint-Services/operation/createPrivateEndpoint. @@ -78,7 +78,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index b0df7056..27375037 100644 --- a/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices createPrivateEndpointService `Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. -This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. +This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Private-Endpoint-Services/operation/createPrivateEndpointService. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index bc80c3c6..80358514 100644 --- a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices deletePrivateEndpoint `Public Preview: please provide feedback at `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. -When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. +When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Private-Endpoint-Services/operation/deletePrivateEndpoint. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index cee726ba..5b92c641 100644 --- a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices deletePrivateEndpointService `Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. -This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. +This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Private-Endpoint-Services/operation/deletePrivateEndpointService. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 privateEndpointServices deletePrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices deletePrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 3a567553..0ab13b9e 100644 --- a/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getPrivateEndpoint `Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. -The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. +The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Private-Endpoint-Services/operation/getPrivateEndpoint. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 privateEndpointServices getPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index bd278302..c565485b 100644 --- a/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getPrivateEndpointService `Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. -The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. +The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Private-Endpoint-Services/operation/getPrivateEndpointService. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 privateEndpointServices getPrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getPrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 44b40db9..8e60b499 100644 --- a/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting `Public Preview: please provide feedback at `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. +The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 privateEndpointServices getRegionalizedPrivateEndpointSetting --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index cd38c70f..de2a7e11 100644 --- a/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices listPrivateEndpointServices `Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. +This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Private-Endpoint-Services/operation/listPrivateEndpointServices. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 privateEndpointServices listPrivateEndpointServices --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices listPrivateEndpointServices --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index b43326c3..44dcc976 100644 --- a/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting `Public Preview: please provide feedback at `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. -The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. +The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. 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/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 697ef499..d7e850c2 100644 --- a/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys addProjectApiKey `Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. -Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. +Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Programmatic-API-Keys/operation/addProjectApiKey. @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createApiKey.txt b/source/command/atlas-api-programmaticApiKeys-createApiKey.txt index 8f6782e2..f75fb372 100644 --- a/source/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createApiKey `Public Preview: please provide feedback at `_: Creates one API key for the specified organization. -An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization Owner role. +An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Programmatic-API-Keys/operation/createApiKey. @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index b01a9730..1e190ccb 100644 --- a/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createApiKeyAccessList `Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. -Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write 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/Programmatic-API-Keys/operation/createApiKeyAccessList. @@ -84,7 +84,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 81d4f685..cb2e1cf5 100644 --- a/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createProjectApiKey `Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. -Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Programmatic-API-Keys/operation/createProjectApiKey. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index a1716694..234bbc7d 100644 --- a/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys deleteApiKey `Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. -When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. +When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Programmatic-API-Keys/operation/deleteApiKey. @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 programmaticApiKeys deleteApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys deleteApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 64df0e37..8f9fbbb2 100644 --- a/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. -Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. +Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. 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/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry. @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 programmaticApiKeys deleteApiKeyAccessListEntry --version 2023-01-01 --apiUserId [apiUserId] --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys deleteApiKeyAccessListEntry --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-getApiKey.txt b/source/command/atlas-api-programmaticApiKeys-getApiKey.txt index 0355887f..82587a99 100644 --- a/source/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys getApiKey `Public Preview: please provide feedback at `_: Returns one organization API key. -The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Programmatic-API-Keys/operation/getApiKey. @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 programmaticApiKeys getApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys getApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index cd1c50a8..a86c612c 100644 --- a/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys getApiKeyAccessList `Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. -Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Programmatic-API-Keys/operation/getApiKeyAccessList. @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 8f1335e3..e5d3ae0a 100644 --- a/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries. @@ -80,7 +80,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 prettyprint format. * - --version - string - false @@ -103,13 +103,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 programmaticApiKeys listApiKeyAccessListsEntries --version 2023-01-01 --apiUserId [apiUserId] --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api programmaticApiKeys listApiKeyAccessListsEntries --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt index 3b4961ec..20ebed60 100644 --- a/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listApiKeys `Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. -The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Programmatic-API-Keys/operation/listApiKeys. @@ -76,7 +76,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 prettyprint format. * - --version - string - false @@ -99,13 +99,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 programmaticApiKeys listApiKeys --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api programmaticApiKeys listApiKeys --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index a21ed3a5..bbebe91d 100644 --- a/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listProjectApiKeys `Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. -Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Programmatic-API-Keys/operation/listProjectApiKeys. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 programmaticApiKeys listProjectApiKeys --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api programmaticApiKeys listProjectApiKeys --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index ffb1a898..a49b6234 100644 --- a/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys removeProjectApiKey `Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Programmatic-API-Keys/operation/removeProjectApiKey. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 programmaticApiKeys removeProjectApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api programmaticApiKeys removeProjectApiKey --version 2023-01-01 --apiUserId [apiUserId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt index c6dd5d5c..66ee5b4e 100644 --- a/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 429276c9..ac20d21a 100644 --- a/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -86,7 +86,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index a9248946..d0179520 100644 --- a/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList createProjectIpAccessList `Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. -MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. +MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. 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/Project-IP-Access-List/operation/createProjectIpAccessList. @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,14 +105,13 @@ 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 ------------------ - - Adds multiple access list entries to the specified project +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Adds multiple access list entries to the specified project [ { "cidrBlock": "192.168.1.0/24", @@ -125,11 +124,12 @@ Create the file below and save it as `payload.json` ] .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --file payload.json --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Adds multiple access list entries to the specified project + atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --file payload.json --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 35b5acbe..8c93ecb6 100644 --- a/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList deleteProjectIpAccessList `Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. -Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. +Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. 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/Project-IP-Access-List/operation/deleteProjectIpAccessList. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,15 +97,12 @@ 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 ------------------ - - Removes one access list entry from the specified project's IP access list - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList deleteProjectIpAccessList --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Removes one access list entry from the specified project's IP access list + atlas api projectIpAccessList deleteProjectIpAccessList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 32301494..ff2fd277 100644 --- a/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,15 +93,12 @@ 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 ------------------ - - Returns the status of 10.0.0.0/16 - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList getProjectIpAccessListStatus --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Returns the status of 10.0.0.0/16 + atlas api projectIpAccessList getProjectIpAccessListStatus --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 6e4a41ec..8c04db71 100644 --- a/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList getProjectIpList `Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. -Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. 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/Project-IP-Access-List/operation/getProjectIpList. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,15 +93,12 @@ 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 ------------------ - - Returns one access list entry from the specified project's IP access list: 10.0.0.0/16 - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Returns one access list entry from the specified project's IP access list: 10.0.0.0/16 + atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index 8dd8ba77..d83eb7d8 100644 --- a/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList listProjectIpAccessLists `Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. -Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. 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/Project-IP-Access-List/operation/listProjectIpAccessLists. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,15 +101,12 @@ 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 ------------------ - - Returns all access list entries from the specified project's IP access list. - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList listProjectIpAccessLists --version 2023-01-01 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns all access list entries from the specified project's IP access list. + atlas api projectIpAccessList listProjectIpAccessLists --version 2023-01-01 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-addUserToProject.txt b/source/command/atlas-api-projects-addUserToProject.txt index 3940c609..8081a1f7 100644 --- a/source/command/atlas-api-projects-addUserToProject.txt +++ b/source/command/atlas-api-projects-addUserToProject.txt @@ -14,7 +14,7 @@ atlas api projects addUserToProject `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. -If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. +If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User 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/Projects/operation/addUserToProject. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-createProject.txt b/source/command/atlas-api-projects-createProject.txt index 7b10a198..885b674b 100644 --- a/source/command/atlas-api-projects-createProject.txt +++ b/source/command/atlas-api-projects-createProject.txt @@ -14,7 +14,7 @@ atlas api projects createProject `Public Preview: please provide feedback at `_: Creates one project. -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Read Write role. +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write 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/Projects/operation/createProject. @@ -64,7 +64,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 prettyprint format. * - --projectOwnerId - string - false @@ -91,14 +91,13 @@ 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 ------------------ - - Creates a new project named "MongoTube" with an environment tag set to "e2e" +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Creates a new project named "MongoTube" with an environment tag set to "e2e" { "name": "MongoTube", "orgId": "67b715468c10250b968dcb84", @@ -111,11 +110,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projects createProject --version 2023-01-01 --file payload.json --envelope false --pretty false + # Creates a new project named "MongoTube" with an environment tag set to "e2e" + atlas api projects createProject --version 2023-01-01 --file payload.json .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-createProjectInvitation.txt b/source/command/atlas-api-projects-createProjectInvitation.txt index dd2d0518..cad4bb4b 100644 --- a/source/command/atlas-api-projects-createProjectInvitation.txt +++ b/source/command/atlas-api-projects-createProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects createProjectInvitation `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. -The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role. +The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/createProjectInvitation. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-deleteProject.txt b/source/command/atlas-api-projects-deleteProject.txt index 6accf1af..b54ca218 100644 --- a/source/command/atlas-api-projects-deleteProject.txt +++ b/source/command/atlas-api-projects-deleteProject.txt @@ -14,7 +14,7 @@ atlas api projects deleteProject `Public Preview: please provide feedback at `_: Removes the specified project. -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/deleteProject. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,15 +89,12 @@ 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 ------------------ - - Deletes an existing project - -Run the command below. +-------- .. code-block:: - atlas api projects deleteProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Deletes an existing project + atlas api projects deleteProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-deleteProjectInvitation.txt b/source/command/atlas-api-projects-deleteProjectInvitation.txt index 55d8dbf9..0b97f0e6 100644 --- a/source/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/source/command/atlas-api-projects-deleteProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects deleteProjectInvitation `Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role. +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/deleteProjectInvitation. @@ -89,13 +89,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 projects deleteProjectInvitation --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] + atlas api projects deleteProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-deleteProjectLimit.txt b/source/command/atlas-api-projects-deleteProjectLimit.txt index c449f154..0cdc8413 100644 --- a/source/command/atlas-api-projects-deleteProjectLimit.txt +++ b/source/command/atlas-api-projects-deleteProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects deleteProjectLimit `Public Preview: please provide feedback at `_: Removes the specified project limit. -Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. +Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/deleteProjectLimit. @@ -87,7 +87,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 prettyprint format. * - --version - string - false @@ -110,13 +110,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 projects deleteProjectLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false + atlas api projects deleteProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProject.txt b/source/command/atlas-api-projects-getProject.txt index df035cd9..fbb77fee 100644 --- a/source/command/atlas-api-projects-getProject.txt +++ b/source/command/atlas-api-projects-getProject.txt @@ -14,7 +14,7 @@ atlas api projects getProject `Public Preview: please provide feedback at `_: Returns details about the specified project. -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Projects/operation/getProject. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,15 +89,12 @@ 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 ------------------ - - Get a project using a project id - -Run the command below. +-------- .. code-block:: - atlas api projects getProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Get a project using a project id + atlas api projects getProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectByName.txt b/source/command/atlas-api-projects-getProjectByName.txt index ec1a9afe..61a66116 100644 --- a/source/command/atlas-api-projects-getProjectByName.txt +++ b/source/command/atlas-api-projects-getProjectByName.txt @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -86,14 +86,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 projects getProjectByName --version 2023-01-01 --envelope false --groupName [groupName] --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-projects-getProjectInvitation.txt b/source/command/atlas-api-projects-getProjectInvitation.txt index 48b46cdc..02fd035f 100644 --- a/source/command/atlas-api-projects-getProjectInvitation.txt +++ b/source/command/atlas-api-projects-getProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects getProjectInvitation `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/getProjectInvitation. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 projects getProjectInvitation --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] --pretty false + atlas api projects getProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectLimit.txt b/source/command/atlas-api-projects-getProjectLimit.txt index 8a1aea9a..735a24e9 100644 --- a/source/command/atlas-api-projects-getProjectLimit.txt +++ b/source/command/atlas-api-projects-getProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects getProjectLimit `Public Preview: please provide feedback at `_: Returns the specified limit for 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. 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/Projects/operation/getProjectLimit. @@ -87,7 +87,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 prettyprint format. * - --version - string - false @@ -110,13 +110,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 projects getProjectLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false + atlas api projects getProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectLtsVersions.txt b/source/command/atlas-api-projects-getProjectLtsVersions.txt index 7a4a1937..cd17f1be 100644 --- a/source/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/source/command/atlas-api-projects-getProjectLtsVersions.txt @@ -84,7 +84,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 prettyprint format. * - --version - string - false @@ -107,13 +107,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 projects getProjectLtsVersions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceSize M10 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api projects getProjectLtsVersions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceSize M10 --itemsPerPage 100 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectSettings.txt b/source/command/atlas-api-projects-getProjectSettings.txt index 5d9e3dd2..62f48ea9 100644 --- a/source/command/atlas-api-projects-getProjectSettings.txt +++ b/source/command/atlas-api-projects-getProjectSettings.txt @@ -14,7 +14,7 @@ atlas api projects getProjectSettings `Public Preview: please provide feedback at `_: Returns details about the specified project's settings. -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. 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/Projects/operation/getProjectSettings. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 projects getProjectSettings --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects getProjectSettings --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjectInvitations.txt b/source/command/atlas-api-projects-listProjectInvitations.txt index 15b14a52..86ee8a71 100644 --- a/source/command/atlas-api-projects-listProjectInvitations.txt +++ b/source/command/atlas-api-projects-listProjectInvitations.txt @@ -14,7 +14,7 @@ atlas api projects listProjectInvitations `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/listProjectInvitations. @@ -66,7 +66,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 prettyprint format. * - --username - string - false @@ -93,13 +93,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 projects listProjectInvitations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects listProjectInvitations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjectLimits.txt b/source/command/atlas-api-projects-listProjectLimits.txt index c9424338..7cca9c94 100644 --- a/source/command/atlas-api-projects-listProjectLimits.txt +++ b/source/command/atlas-api-projects-listProjectLimits.txt @@ -14,7 +14,7 @@ atlas api projects listProjectLimits `Public Preview: please provide feedback at `_: Returns all the limits for 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. 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/Projects/operation/listProjectLimits. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 projects listProjectLimits --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects listProjectLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjects.txt b/source/command/atlas-api-projects-listProjects.txt index 3de60f74..26c0b8a9 100644 --- a/source/command/atlas-api-projects-listProjects.txt +++ b/source/command/atlas-api-projects-listProjects.txt @@ -14,7 +14,7 @@ atlas api projects listProjects `Public Preview: please provide feedback at `_: Returns details about all projects. -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Organization Read Only role or higher. +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. 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/Projects/operation/listProjects. @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,15 +95,12 @@ 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 ------------------ - - Get a list of all projects inside of the organisation - -Run the command below. +-------- .. code-block:: - atlas api projects listProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Get a list of all projects inside of the organisation + atlas api projects listProjects --version 2023-01-01 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 4dac1f34..986d4c11 100644 --- a/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -14,7 +14,7 @@ atlas api projects migrateProjectToAnotherOrg `Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. -All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. +All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Projects/operation/migrateProjectToAnotherOrg. diff --git a/source/command/atlas-api-projects-returnAllIpAddresses.txt b/source/command/atlas-api-projects-returnAllIpAddresses.txt index 00fbfd37..e201d8f2 100644 --- a/source/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/source/command/atlas-api-projects-returnAllIpAddresses.txt @@ -14,7 +14,7 @@ atlas api projects returnAllIpAddresses `Public Preview: please provide feedback at `_: Returns all IP addresses for this 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. 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/Projects/operation/returnAllIpAddresses. @@ -66,7 +66,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 prettyprint format. * - --version - string - false @@ -89,13 +89,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 projects returnAllIpAddresses --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects returnAllIpAddresses --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-setProjectLimit.txt b/source/command/atlas-api-projects-setProjectLimit.txt index db1875c4..c65b5d74 100644 --- a/source/command/atlas-api-projects-setProjectLimit.txt +++ b/source/command/atlas-api-projects-setProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects setProjectLimit `Public Preview: please provide feedback at `_: Sets the specified project limit. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. @@ -94,7 +94,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-updateProject.txt b/source/command/atlas-api-projects-updateProject.txt index 96fed1dc..0cc1f174 100644 --- a/source/command/atlas-api-projects-updateProject.txt +++ b/source/command/atlas-api-projects-updateProject.txt @@ -14,7 +14,7 @@ atlas api projects updateProject `Public Preview: please provide feedback at `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/updateProject. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,14 +93,13 @@ 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 ------------------ - - Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" { "name": "MongoTube - Production", "tags": [ @@ -112,11 +111,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projects updateProject --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" + atlas api projects updateProject --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-updateProjectInvitation.txt b/source/command/atlas-api-projects-updateProjectInvitation.txt index 72117530..5b8f40b5 100644 --- a/source/command/atlas-api-projects-updateProjectInvitation.txt +++ b/source/command/atlas-api-projects-updateProjectInvitation.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-updateProjectRoles.txt b/source/command/atlas-api-projects-updateProjectRoles.txt index 41f86c05..66f146b2 100644 --- a/source/command/atlas-api-projects-updateProjectRoles.txt +++ b/source/command/atlas-api-projects-updateProjectRoles.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectRoles `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. -To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User 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/Projects/operation/updateProjectRoles. @@ -70,7 +70,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 prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-projects-updateProjectSettings.txt b/source/command/atlas-api-projects-updateProjectSettings.txt index 8341f6c9..ad3e8756 100644 --- a/source/command/atlas-api-projects-updateProjectSettings.txt +++ b/source/command/atlas-api-projects-updateProjectSettings.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectSettings `Public Preview: please provide feedback at `_: Updates the settings of the specified project. -You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. +You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Projects/operation/updateProjectSettings. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index d20b8bc1..67163351 100644 --- a/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index 6811e076..45112da9 100644 --- a/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 pushBasedLogExport deletePushBasedLogConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api pushBasedLogExport deletePushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index 33828f03..16e1ef9d 100644 --- a/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -64,7 +64,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 prettyprint format. * - --version - string - false @@ -87,13 +87,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 pushBasedLogExport getPushBasedLogConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api pushBasedLogExport getPushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index 0884059f..cfea652e 100644 --- a/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 8117a85b..1c8265e1 100644 --- a/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -66,7 +66,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 93a1f11f..0cdb4aca 100644 --- a/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -62,7 +62,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 prettyprint format. * - --resourcePolicyId - string - true @@ -89,13 +89,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 resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --resourcePolicyId 32b6e34b3d91647abb20e7b8 + atlas api resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index a6ebb997..231863ce 100644 --- a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -62,7 +62,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 prettyprint format. * - --version - string - false @@ -85,13 +85,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 resourcePolicies getAtlasResourcePolicies --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api resourcePolicies getAtlasResourcePolicies --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 3bf81cdf..397f284b 100644 --- a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -62,7 +62,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 prettyprint format. * - --resourcePolicyId - string - true @@ -89,13 +89,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 resourcePolicies getAtlasResourcePolicy --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --resourcePolicyId 32b6e34b3d91647abb20e7b8 + atlas api resourcePolicies getAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index d9bafb96..c85dd806 100644 --- a/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -62,7 +62,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 prettyprint format. * - --version - string - false @@ -85,13 +85,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 resourcePolicies getResourcesNonCompliant --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api resourcePolicies getResourcesNonCompliant --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index 95724f1f..c724c697 100644 --- a/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -66,7 +66,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 prettyprint format. * - --resourcePolicyId - string - true diff --git a/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index 3227fa76..38538ea3 100644 --- a/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -66,7 +66,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-rollingIndex-createRollingIndex.txt b/source/command/atlas-api-rollingIndex-createRollingIndex.txt index 01dab375..83b5c811 100644 --- a/source/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/source/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -14,7 +14,7 @@ atlas api rollingIndex createRollingIndex `Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. -Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. +Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data 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/Rolling-Index/operation/createRollingIndex. @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,18 +97,18 @@ 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 ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_2dspere_index - 2dspere Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # 2dspere Index { "collation": { "alternate": "non-ignorable", @@ -140,23 +140,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # 2dspere Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2023-01-01_partial_index - Partial Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Partial Index { "collation": { "alternate": "non-ignorable", @@ -188,23 +188,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Partial Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2023-01-01_sparse_index - Sparse Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Sparse Index { "collation": { "alternate": "non-ignorable", @@ -232,11 +232,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Sparse Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-root-getSystemStatus.txt b/source/command/atlas-api-root-getSystemStatus.txt index 9a75c71e..805330aa 100644 --- a/source/command/atlas-api-root-getSystemStatus.txt +++ b/source/command/atlas-api-root-getSystemStatus.txt @@ -58,7 +58,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 prettyprint format. * - --version - string - false @@ -80,14 +80,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 root getSystemStatus --version 2023-01-01 --envelope false --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 1094287e..5126ce19 100644 --- a/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -76,14 +76,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 root returnAllControlPlaneIpAddresses --version 2023-11-15 --envelope false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 4acc409f..b755a057 100644 --- a/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -17,7 +17,7 @@ atlas api serverlessInstances createServerlessInstance This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. -Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. +Creates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Serverless-Instances/operation/createServerlessInstance. @@ -73,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 1bd4fbd8..dc5b89d3 100644 --- a/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances deleteServerlessInstance `Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. -The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. +The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead. @@ -73,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 prettyprint format. * - --version - string - false @@ -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 serverlessInstances deleteServerlessInstance --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api serverlessInstances deleteServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 58fa0ed8..b5e5750f 100644 --- a/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances getServerlessInstance `Public Preview: please provide feedback at `_: Returns details for one serverless instance in 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. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead. @@ -73,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 prettyprint format. * - --version - string - false @@ -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 serverlessInstances getServerlessInstance --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api serverlessInstances getServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt index c15882df..19e8bcda 100644 --- a/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances listServerlessInstances `Public Preview: please provide feedback at `_: Returns details for all serverless instances in 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. This endpoint also lists Flex clusters that were created using the createServerlessInstance endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead. @@ -81,7 +81,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 prettyprint format. * - --version - string - false @@ -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 serverlessInstances listServerlessInstances --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serverlessInstances listServerlessInstances --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 0e662a89..8207d9ed 100644 --- a/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances updateServerlessInstance `Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index 0d66e128..ffd76047 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint `Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index f292cef4..1fbe1db5 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint `Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. @@ -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 serverlessPrivateEndpoints deleteServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index 90ac21e4..a01ef4a3 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -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 serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 7ab86bbf..0e9d3f4d 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -92,13 +92,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 serverlessPrivateEndpoints listServerlessPrivateEndpoints --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index b49384a4..fb10012a 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint `Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. diff --git a/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index 03ecafd1..1cdec449 100644 --- a/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 906723f6..bbcb0e79 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 0b846bec..dff15d99 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -86,7 +86,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 696da2f9..813b2841 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccount.txt b/source/command/atlas-api-serviceAccounts-createServiceAccount.txt index 7ca4e692..f921429a 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index ef4b3c00..b8d49e1b 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -84,7 +84,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 80729484..4b489eba 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 2a6bb14f..b8e725a2 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 serviceAccounts deleteProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api serviceAccounts deleteProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 72463d45..8ee047b6 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24 --pretty false + atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index 32d037dd..5f7864f7 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -70,7 +70,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 prettyprint format. * - --secretId - string - true @@ -97,13 +97,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 serviceAccounts deleteProjectServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --secretId [secretId] + atlas api serviceAccounts deleteProjectServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --secretId [secretId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index ff0db32d..32635df1 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 serviceAccounts deleteServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts deleteServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index c14ba383..c2f24878 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 serviceAccounts deleteServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts deleteServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index b016c5e3..64069df7 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -68,7 +68,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 prettyprint format. * - --secretId - string - true @@ -95,13 +95,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 serviceAccounts deleteServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --secretId [secretId] + atlas api serviceAccounts deleteServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 --secretId [secretId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index cd1710c5..d99b7d93 100644 --- a/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 serviceAccounts getProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api serviceAccounts getProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-getServiceAccount.txt b/source/command/atlas-api-serviceAccounts-getServiceAccount.txt index b228d086..e5232afd 100644 --- a/source/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -68,7 +68,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 prettyprint format. * - --version - string - false @@ -91,13 +91,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 serviceAccounts getServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts getServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index b4a69d91..499030e4 100644 --- a/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -82,7 +82,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 prettyprint format. * - --version - string - false @@ -105,13 +105,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 serviceAccounts listProjectServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serviceAccounts listProjectServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 18d1bf18..0e07f658 100644 --- a/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 serviceAccounts listProjectServiceAccounts --version 2024-08-05 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serviceAccounts listProjectServiceAccounts --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 7134c7ff..06e9730f 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -80,7 +80,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 prettyprint format. * - --version - string - false @@ -103,13 +103,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 serviceAccounts listServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 2c56cb45..c5f68745 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -76,7 +76,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 prettyprint format. * - --version - string - false @@ -99,13 +99,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 serviceAccounts listServiceAccountProjects --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccountProjects --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 70d60a77..0805a0e1 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 serviceAccounts listServiceAccounts --version 2024-08-05 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccounts --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 52558efa..a28b9e80 100644 --- a/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 3507c3fb..85e7c6a8 100644 --- a/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index d57ceaed..f0781aa4 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob `Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. -MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. +MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 135a634e..7cca6c41 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob `Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. -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. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. @@ -73,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 prettyprint format. * - --restoreId - string - true @@ -100,13 +100,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 sharedTierRestoreJobs getSharedClusterBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreId [restoreId] + atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreId [restoreId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 5b908ba0..e4167337 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs `Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. -Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. +Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. @@ -73,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 prettyprint format. * - --version - string - false @@ -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 sharedTierRestoreJobs listSharedClusterBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index 0c335a12..c3e3f46d 100644 --- a/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup `Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. -This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. +This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. @@ -77,7 +77,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index a901c0a6..6b8ea5c2 100644 --- a/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots getSharedClusterBackup `Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. -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. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. @@ -73,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 prettyprint format. * - --snapshotId - string - true @@ -100,13 +100,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 sharedTierSnapshots getSharedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api sharedTierSnapshots getSharedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index b8361e77..d9d63b67 100644 --- a/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots listSharedClusterBackups `Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. -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. This API also works for Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. @@ -73,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 prettyprint format. * - --version - string - false @@ -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 sharedTierSnapshots listSharedClusterBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api sharedTierSnapshots listSharedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-createPrivateLinkConnection.txt b/source/command/atlas-api-streams-createPrivateLinkConnection.txt index f985757f..dda28421 100644 --- a/source/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams createPrivateLinkConnection `Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. -To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner 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/Streams/operation/createPrivateLinkConnection. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamConnection.txt b/source/command/atlas-api-streams-createStreamConnection.txt index f502f05b..6d99dba2 100644 --- a/source/command/atlas-api-streams-createStreamConnection.txt +++ b/source/command/atlas-api-streams-createStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams createStreamConnection `Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner 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/Streams/operation/createStreamConnection. @@ -70,7 +70,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 prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-createStreamInstance.txt b/source/command/atlas-api-streams-createStreamInstance.txt index b8be5b78..40c43988 100644 --- a/source/command/atlas-api-streams-createStreamInstance.txt +++ b/source/command/atlas-api-streams-createStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams createStreamInstance `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. -To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner 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/Streams/operation/createStreamInstance. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index e9e574c1..b9fa5ae2 100644 --- a/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -14,7 +14,7 @@ atlas api streams createStreamInstanceWithSampleConnections `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. -To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. +To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner 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/Streams/operation/createStreamInstanceWithSampleConnections. @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamProcessor.txt b/source/command/atlas-api-streams-createStreamProcessor.txt index ceb0e9a0..430ba2a5 100644 --- a/source/command/atlas-api-streams-createStreamProcessor.txt +++ b/source/command/atlas-api-streams-createStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams createStreamProcessor `Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/createStreamProcessor. @@ -70,7 +70,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 prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-deletePrivateLinkConnection.txt b/source/command/atlas-api-streams-deletePrivateLinkConnection.txt index 3b7f6167..b18f09a0 100644 --- a/source/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams deletePrivateLinkConnection `Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. -To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner 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/Streams/operation/deletePrivateLinkConnection. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 streams deletePrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api streams deletePrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamConnection.txt b/source/command/atlas-api-streams-deleteStreamConnection.txt index 585df57c..206913db 100644 --- a/source/command/atlas-api-streams-deleteStreamConnection.txt +++ b/source/command/atlas-api-streams-deleteStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamConnection `Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/deleteStreamConnection. @@ -70,7 +70,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 prettyprint format. * - --tenantName - string - true @@ -97,13 +97,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 streams deleteStreamConnection --version 2023-02-01 --connectionName [connectionName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api streams deleteStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamInstance.txt b/source/command/atlas-api-streams-deleteStreamInstance.txt index 53d40e2d..a2b2bd3f 100644 --- a/source/command/atlas-api-streams-deleteStreamInstance.txt +++ b/source/command/atlas-api-streams-deleteStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamInstance `Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. -To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner 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/Streams/operation/deleteStreamInstance. @@ -66,7 +66,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 prettyprint format. * - --tenantName - string - true @@ -93,13 +93,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 streams deleteStreamInstance --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api streams deleteStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamProcessor.txt b/source/command/atlas-api-streams-deleteStreamProcessor.txt index fc08fe0e..fa02be58 100644 --- a/source/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/source/command/atlas-api-streams-deleteStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamProcessor `Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/deleteStreamProcessor. @@ -66,7 +66,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 prettyprint format. * - --processorName - string - true @@ -97,13 +97,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 streams deleteStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams deleteStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 7e016402..8692d102 100644 --- a/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -87,13 +87,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 streams deleteVpcPeeringConnection --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --id [id] + atlas api streams deleteVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 3e377d11..04a44fed 100644 --- a/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -14,7 +14,7 @@ atlas api streams downloadStreamTenantAuditLogs `Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. -By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". +By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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/Streams/operation/downloadStreamTenantAuditLogs. @@ -97,13 +97,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 streams downloadStreamTenantAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] + atlas api streams downloadStreamTenantAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getAccountDetails.txt b/source/command/atlas-api-streams-getAccountDetails.txt index 8bb85dfa..02918233 100644 --- a/source/command/atlas-api-streams-getAccountDetails.txt +++ b/source/command/atlas-api-streams-getAccountDetails.txt @@ -91,13 +91,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 streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName] + atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index 0b07d7f6..572595c3 100644 --- a/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 streams getActiveVpcPeeringConnections --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams getActiveVpcPeeringConnections --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getPrivateLinkConnection.txt b/source/command/atlas-api-streams-getPrivateLinkConnection.txt index dda6769c..08564dec 100644 --- a/source/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams getPrivateLinkConnection `Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the 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. 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/Streams/operation/getPrivateLinkConnection. @@ -89,13 +89,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 streams getPrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api streams getPrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamConnection.txt b/source/command/atlas-api-streams-getStreamConnection.txt index 0eb1a172..31255862 100644 --- a/source/command/atlas-api-streams-getStreamConnection.txt +++ b/source/command/atlas-api-streams-getStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams getStreamConnection `Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. -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. 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/Streams/operation/getStreamConnection. @@ -93,13 +93,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 streams getStreamConnection --version 2023-02-01 --connectionName [connectionName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api streams getStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamInstance.txt b/source/command/atlas-api-streams-getStreamInstance.txt index c17bc048..b3d264bc 100644 --- a/source/command/atlas-api-streams-getStreamInstance.txt +++ b/source/command/atlas-api-streams-getStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams getStreamInstance `Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. -To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner 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/Streams/operation/getStreamInstance. @@ -93,13 +93,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 streams getStreamInstance --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api streams getStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamProcessor.txt b/source/command/atlas-api-streams-getStreamProcessor.txt index 9a54dc5a..f84028f6 100644 --- a/source/command/atlas-api-streams-getStreamProcessor.txt +++ b/source/command/atlas-api-streams-getStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams getStreamProcessor `Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/getStreamProcessor. @@ -66,7 +66,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 prettyprint format. * - --processorName - string - true @@ -97,13 +97,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 streams getStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams getStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getVpcPeeringConnections.txt b/source/command/atlas-api-streams-getVpcPeeringConnections.txt index 937aaa77..08cc1d3e 100644 --- a/source/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/source/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -72,7 +72,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 prettyprint format. * - --requesterAccountId - string - true @@ -99,13 +99,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 streams getVpcPeeringConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false --requesterAccountId [requesterAccountId] + atlas api streams getVpcPeeringConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --requesterAccountId [requesterAccountId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listPrivateLinkConnections.txt b/source/command/atlas-api-streams-listPrivateLinkConnections.txt index daf2c2f9..15770a04 100644 --- a/source/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/source/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -74,7 +74,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 prettyprint format. * - --version - string - false @@ -97,13 +97,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 streams listPrivateLinkConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams listPrivateLinkConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamConnections.txt b/source/command/atlas-api-streams-listStreamConnections.txt index 63d1c945..ae44269e 100644 --- a/source/command/atlas-api-streams-listStreamConnections.txt +++ b/source/command/atlas-api-streams-listStreamConnections.txt @@ -74,7 +74,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 prettyprint format. * - --tenantName - string - true @@ -101,13 +101,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 streams listStreamConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false --tenantName [tenantName] + atlas api streams listStreamConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamInstances.txt b/source/command/atlas-api-streams-listStreamInstances.txt index 605a9cb3..4c4015ba 100644 --- a/source/command/atlas-api-streams-listStreamInstances.txt +++ b/source/command/atlas-api-streams-listStreamInstances.txt @@ -72,7 +72,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 prettyprint format. * - --version - string - false @@ -95,13 +95,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 streams listStreamInstances --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams listStreamInstances --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamProcessors.txt b/source/command/atlas-api-streams-listStreamProcessors.txt index cbd3ca62..7a77832f 100644 --- a/source/command/atlas-api-streams-listStreamProcessors.txt +++ b/source/command/atlas-api-streams-listStreamProcessors.txt @@ -14,7 +14,7 @@ atlas api streams listStreamProcessors `Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/listStreamProcessors. @@ -78,7 +78,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 prettyprint format. * - --tenantName - string - true @@ -105,13 +105,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 streams listStreamProcessors --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --tenantName [tenantName] + atlas api streams listStreamProcessors --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-modifyStreamProcessor.txt b/source/command/atlas-api-streams-modifyStreamProcessor.txt index 8eae958a..cfef8ef6 100644 --- a/source/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/source/command/atlas-api-streams-modifyStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams modifyStreamProcessor `Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/modifyStreamProcessor. @@ -70,7 +70,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 prettyprint format. * - --processorName - string - true diff --git a/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 4f067d2a..0074a458 100644 --- a/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -87,13 +87,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 streams rejectVpcPeeringConnection --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --id [id] + atlas api streams rejectVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-startStreamProcessor.txt b/source/command/atlas-api-streams-startStreamProcessor.txt index 2b7ca199..a2315ead 100644 --- a/source/command/atlas-api-streams-startStreamProcessor.txt +++ b/source/command/atlas-api-streams-startStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams startStreamProcessor `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/startStreamProcessor. @@ -66,7 +66,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 prettyprint format. * - --processorName - string - true @@ -97,13 +97,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 streams startStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams startStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-stopStreamProcessor.txt b/source/command/atlas-api-streams-stopStreamProcessor.txt index 2c2557b4..fff74677 100644 --- a/source/command/atlas-api-streams-stopStreamProcessor.txt +++ b/source/command/atlas-api-streams-stopStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams stopStreamProcessor `Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/stopStreamProcessor. @@ -66,7 +66,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 prettyprint format. * - --processorName - string - true @@ -97,13 +97,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 streams stopStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams stopStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-updateStreamConnection.txt b/source/command/atlas-api-streams-updateStreamConnection.txt index 4c98482c..bb68b6e7 100644 --- a/source/command/atlas-api-streams-updateStreamConnection.txt +++ b/source/command/atlas-api-streams-updateStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams updateStreamConnection `Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner 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/Streams/operation/updateStreamConnection. @@ -74,7 +74,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 prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-updateStreamInstance.txt b/source/command/atlas-api-streams-updateStreamInstance.txt index 8f418add..b5cd3849 100644 --- a/source/command/atlas-api-streams-updateStreamInstance.txt +++ b/source/command/atlas-api-streams-updateStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams updateStreamInstance `Public Preview: please provide feedback at `_: Update one stream instance in the specified project. -To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner 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/Streams/operation/updateStreamInstance. @@ -70,7 +70,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 prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-teams-addAllTeamsToProject.txt b/source/command/atlas-api-teams-addAllTeamsToProject.txt index 2ae84e27..46843dc7 100644 --- a/source/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/source/command/atlas-api-teams-addAllTeamsToProject.txt @@ -70,7 +70,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-teams-addTeamUser.txt b/source/command/atlas-api-teams-addTeamUser.txt index f1c38d70..8b06942f 100644 --- a/source/command/atlas-api-teams-addTeamUser.txt +++ b/source/command/atlas-api-teams-addTeamUser.txt @@ -14,7 +14,7 @@ atlas api teams addTeamUser `Public Preview: please provide feedback at `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. -Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. +Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Add One MongoDB Cloud User to One Team to add an active or pending user to a team. @@ -71,7 +71,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 prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-teams-createTeam.txt b/source/command/atlas-api-teams-createTeam.txt index febd052b..5fc66501 100644 --- a/source/command/atlas-api-teams-createTeam.txt +++ b/source/command/atlas-api-teams-createTeam.txt @@ -14,7 +14,7 @@ atlas api teams createTeam `Public Preview: please provide feedback at `_: Creates one team in the specified organization. -Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role. +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Teams/operation/createTeam. @@ -68,7 +68,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-teams-deleteTeam.txt b/source/command/atlas-api-teams-deleteTeam.txt index 1e81db78..aeef1ea1 100644 --- a/source/command/atlas-api-teams-deleteTeam.txt +++ b/source/command/atlas-api-teams-deleteTeam.txt @@ -14,7 +14,7 @@ atlas api teams deleteTeam `Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Teams/operation/deleteTeam. @@ -64,7 +64,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 prettyprint format. * - --teamId - string - true @@ -91,13 +91,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 teams deleteTeam --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] + atlas api teams deleteTeam --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-getTeamById.txt b/source/command/atlas-api-teams-getTeamById.txt index 055769d7..da470c3b 100644 --- a/source/command/atlas-api-teams-getTeamById.txt +++ b/source/command/atlas-api-teams-getTeamById.txt @@ -14,7 +14,7 @@ atlas api teams getTeamById `Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. -This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Teams/operation/getTeamById. @@ -64,7 +64,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 prettyprint format. * - --teamId - string - true @@ -91,13 +91,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 teams getTeamById --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] + atlas api teams getTeamById --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-getTeamByName.txt b/source/command/atlas-api-teams-getTeamByName.txt index b559f9a2..2deb71ec 100644 --- a/source/command/atlas-api-teams-getTeamByName.txt +++ b/source/command/atlas-api-teams-getTeamByName.txt @@ -14,7 +14,7 @@ atlas api teams getTeamByName `Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. -This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Teams/operation/getTeamByName. @@ -64,7 +64,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 prettyprint format. * - --teamName - string - true @@ -91,13 +91,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 teams getTeamByName --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamName [teamName] + atlas api teams getTeamByName --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamName [teamName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-listOrganizationTeams.txt b/source/command/atlas-api-teams-listOrganizationTeams.txt index 2c14344c..f1cd90df 100644 --- a/source/command/atlas-api-teams-listOrganizationTeams.txt +++ b/source/command/atlas-api-teams-listOrganizationTeams.txt @@ -14,7 +14,7 @@ atlas api teams listOrganizationTeams `Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. -Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member 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/Teams/operation/listOrganizationTeams. @@ -76,7 +76,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 prettyprint format. * - --version - string - false @@ -99,13 +99,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 teams listOrganizationTeams --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api teams listOrganizationTeams --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-listProjectTeams.txt b/source/command/atlas-api-teams-listProjectTeams.txt index 28f164ed..b9423ecf 100644 --- a/source/command/atlas-api-teams-listProjectTeams.txt +++ b/source/command/atlas-api-teams-listProjectTeams.txt @@ -14,7 +14,7 @@ atlas api teams listProjectTeams `Public Preview: please provide feedback at `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. +All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/Teams/operation/listProjectTeams. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 teams listProjectTeams --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api teams listProjectTeams --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-removeProjectTeam.txt b/source/command/atlas-api-teams-removeProjectTeam.txt index 680e40ae..87e83468 100644 --- a/source/command/atlas-api-teams-removeProjectTeam.txt +++ b/source/command/atlas-api-teams-removeProjectTeam.txt @@ -14,7 +14,7 @@ atlas api teams removeProjectTeam `Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -To use this resource, the requesting API Key must have the Project Owner role. +To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Teams/operation/removeProjectTeam. @@ -89,13 +89,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 teams removeProjectTeam --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] + atlas api teams removeProjectTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-removeTeamUser.txt b/source/command/atlas-api-teams-removeTeamUser.txt index 0637d394..16cbd371 100644 --- a/source/command/atlas-api-teams-removeTeamUser.txt +++ b/source/command/atlas-api-teams-removeTeamUser.txt @@ -14,7 +14,7 @@ atlas api teams removeTeamUser `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. -This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Remove One MongoDB Cloud User from One Team to remove an active or pending user from a team. @@ -67,7 +67,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 prettyprint format. * - --teamId - string - true @@ -98,13 +98,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 teams removeTeamUser --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] --userId [userId] + atlas api teams removeTeamUser --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-renameTeam.txt b/source/command/atlas-api-teams-renameTeam.txt index 89d02825..b2f0ad73 100644 --- a/source/command/atlas-api-teams-renameTeam.txt +++ b/source/command/atlas-api-teams-renameTeam.txt @@ -14,7 +14,7 @@ atlas api teams renameTeam `Public Preview: please provide feedback at `_: Renames one team in the specified organization. -Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. +Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner 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/Teams/operation/renameTeam. @@ -68,7 +68,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 prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-teams-updateTeamRoles.txt b/source/command/atlas-api-teams-updateTeamRoles.txt index e4043db1..5913fc25 100644 --- a/source/command/atlas-api-teams-updateTeamRoles.txt +++ b/source/command/atlas-api-teams-updateTeamRoles.txt @@ -14,7 +14,7 @@ atlas api teams updateTeamRoles `Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. -You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role. +You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner 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/Teams/operation/updateTeamRoles. @@ -70,7 +70,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 prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index ad3b4f62..1944d410 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration `Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. -These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. +These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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/Third-Party-Integrations/operation/createThirdPartyIntegration. @@ -86,7 +86,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 05155344..c7ddca88 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration `Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. -These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. +These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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/Third-Party-Integrations/operation/deleteThirdPartyIntegration. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 thirdPartyIntegrations deleteThirdPartyIntegration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] --pretty false + atlas api thirdPartyIntegrations deleteThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index e3a219b7..8b76c156 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration `Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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/Third-Party-Integrations/operation/getThirdPartyIntegration. @@ -70,7 +70,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 prettyprint format. * - --version - string - false @@ -93,13 +93,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 thirdPartyIntegrations getThirdPartyIntegration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] --pretty false + atlas api thirdPartyIntegrations getThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 85dbd00e..cc22b59f 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations `Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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/Third-Party-Integrations/operation/listThirdPartyIntegrations. @@ -78,7 +78,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 prettyprint format. * - --version - string - false @@ -101,13 +101,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 thirdPartyIntegrations listThirdPartyIntegrations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api thirdPartyIntegrations listThirdPartyIntegrations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index ab7245ad..cf8ec8b3 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration `Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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/Third-Party-Integrations/operation/updateThirdPartyIntegration. @@ -86,7 +86,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 prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index a29e45b5..4b9e66e1 100644 --- a/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -14,7 +14,7 @@ atlas api x509Authentication createDatabaseUserCertificate `Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. -Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. +Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. @@ -76,7 +76,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 prettyprint format. * - --username - string - true diff --git a/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index 5088fe0f..3b8ba445 100644 --- a/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -85,13 +85,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 x509Authentication disableCustomerManagedX509 --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api x509Authentication disableCustomerManagedX509 --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 36124935..8ef0b19a 100644 --- a/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -14,7 +14,7 @@ atlas api x509Authentication listDatabaseUserCertificates `Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. -This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. +This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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/X.509-Authentication/operation/listDatabaseUserCertificates. @@ -78,7 +78,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 prettyprint format. * - --username - string - true @@ -105,13 +105,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 x509Authentication listDatabaseUserCertificates --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --username [username] + atlas api x509Authentication listDatabaseUserCertificates --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --username [username] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-auditing-update.txt b/source/command/atlas-auditing-update.txt index 6253d205..9db15662 100644 --- a/source/command/atlas-auditing-update.txt +++ b/source/command/atlas-auditing-update.txt @@ -4,9 +4,6 @@ atlas auditing update ===================== -.. meta:: - :description: Update the auditing configuration for a specified project in Atlas using the CLI with various options for customization. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auditing.txt b/source/command/atlas-auditing.txt index 0f55be98..9a2b9b32 100644 --- a/source/command/atlas-auditing.txt +++ b/source/command/atlas-auditing.txt @@ -4,9 +4,6 @@ atlas auditing ============== -.. meta:: - :description: Retrieve database auditing settings for MongoDB Cloud projects using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auth-login.txt b/source/command/atlas-auth-login.txt index 7521679a..689d867f 100644 --- a/source/command/atlas-auth-login.txt +++ b/source/command/atlas-auth-login.txt @@ -4,9 +4,6 @@ atlas auth login ================ -.. meta:: - :description: Authenticate with Atlas using the CLI, with options for government login, browserless access, and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auth-logout.txt b/source/command/atlas-auth-logout.txt index 12b10436..26bae6e3 100644 --- a/source/command/atlas-auth-logout.txt +++ b/source/command/atlas-auth-logout.txt @@ -4,9 +4,6 @@ atlas auth logout ================= -.. meta:: - :description: Log out from the Atlas CLI using the `atlas auth logout` command with optional flags for confirmation and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auth-register.txt b/source/command/atlas-auth-register.txt index a2d282da..e61b2427 100644 --- a/source/command/atlas-auth-register.txt +++ b/source/command/atlas-auth-register.txt @@ -4,9 +4,6 @@ atlas auth register =================== -.. meta:: - :description: Register with Atlas using the CLI command `atlas auth register`, with options for browser session and profile configuration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auth-whoami.txt b/source/command/atlas-auth-whoami.txt index c065cd18..35aabc09 100644 --- a/source/command/atlas-auth-whoami.txt +++ b/source/command/atlas-auth-whoami.txt @@ -4,9 +4,6 @@ atlas auth whoami ================= -.. meta:: - :description: Verify and display your authentication state using the "atlas auth whoami" command with optional profile settings. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-auth.txt b/source/command/atlas-auth.txt index 84a99765..eef0de52 100644 --- a/source/command/atlas-auth.txt +++ b/source/command/atlas-auth.txt @@ -4,9 +4,6 @@ atlas auth ========== -.. meta:: - :description: Manage authentication state in the Atlas CLI, including login, logout, registration, and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-compliancePolicy.txt b/source/command/atlas-backups-compliancePolicy.txt index aeb21ac9..b78e1b53 100644 --- a/source/command/atlas-backups-compliancePolicy.txt +++ b/source/command/atlas-backups-compliancePolicy.txt @@ -4,9 +4,6 @@ atlas backups compliancePolicy ============================== -.. meta:: - :description: Manage cloud backup compliance policies for your project using Atlas CLI commands, including setup and enabling options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-buckets-create.txt b/source/command/atlas-backups-exports-buckets-create.txt index 82af5043..484f78bc 100644 --- a/source/command/atlas-backups-exports-buckets-create.txt +++ b/source/command/atlas-backups-exports-buckets-create.txt @@ -4,9 +4,6 @@ atlas backups exports buckets create ==================================== -.. meta:: - :description: Create an export destination for Atlas backups using an existing AWS S3 bucket with specified options and authentication requirements. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-buckets-delete.txt b/source/command/atlas-backups-exports-buckets-delete.txt index 43c43634..2d46d90e 100644 --- a/source/command/atlas-backups-exports-buckets-delete.txt +++ b/source/command/atlas-backups-exports-buckets-delete.txt @@ -4,9 +4,6 @@ atlas backups exports buckets delete ==================================== -.. meta:: - :description: Delete a snapshot export bucket using the Atlas CLI with options for bucket ID, force, and project ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-buckets-describe.txt b/source/command/atlas-backups-exports-buckets-describe.txt index b735579a..3d32a61e 100644 --- a/source/command/atlas-backups-exports-buckets-describe.txt +++ b/source/command/atlas-backups-exports-buckets-describe.txt @@ -4,9 +4,6 @@ atlas backups exports buckets describe ====================================== -.. meta:: - :description: Describe a snapshot export bucket using the Atlas CLI, requiring authentication and a bucket ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-buckets-list.txt b/source/command/atlas-backups-exports-buckets-list.txt index 5810fb3e..b8997152 100644 --- a/source/command/atlas-backups-exports-buckets-list.txt +++ b/source/command/atlas-backups-exports-buckets-list.txt @@ -4,9 +4,6 @@ atlas backups exports buckets list ================================== -.. meta:: - :description: List cloud backup restore buckets for your project and cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-jobs-create.txt b/source/command/atlas-backups-exports-jobs-create.txt index ce495cd0..94ce5ccd 100644 --- a/source/command/atlas-backups-exports-jobs-create.txt +++ b/source/command/atlas-backups-exports-jobs-create.txt @@ -4,9 +4,6 @@ atlas backups exports jobs create ================================= -.. meta:: - :description: Export a backup snapshot from an M10 or higher Atlas cluster to an AWS S3 bucket using the Atlas CLI command with required options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-jobs-describe.txt b/source/command/atlas-backups-exports-jobs-describe.txt index 3ad2d1a1..01888b54 100644 --- a/source/command/atlas-backups-exports-jobs-describe.txt +++ b/source/command/atlas-backups-exports-jobs-describe.txt @@ -4,9 +4,6 @@ atlas backups exports jobs describe =================================== -.. meta:: - :description: Retrieve details of a specific cloud backup export job for a project and cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-jobs-list.txt b/source/command/atlas-backups-exports-jobs-list.txt index 6c201db9..7471289e 100644 --- a/source/command/atlas-backups-exports-jobs-list.txt +++ b/source/command/atlas-backups-exports-jobs-list.txt @@ -4,9 +4,6 @@ atlas backups exports jobs list =============================== -.. meta:: - :description: List all cloud backup export jobs for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-exports-jobs-watch.txt b/source/command/atlas-backups-exports-jobs-watch.txt index a352310c..c65501c2 100644 --- a/source/command/atlas-backups-exports-jobs-watch.txt +++ b/source/command/atlas-backups-exports-jobs-watch.txt @@ -4,9 +4,6 @@ atlas backups exports jobs watch ================================ -.. meta:: - :description: Monitor the status of an export job in Atlas until it completes, fails, or is canceled, using the CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-restores-describe.txt b/source/command/atlas-backups-restores-describe.txt index fc83a4b1..b79ffee1 100644 --- a/source/command/atlas-backups-restores-describe.txt +++ b/source/command/atlas-backups-restores-describe.txt @@ -4,9 +4,6 @@ atlas backups restores describe =============================== -.. meta:: - :description: Describe a cloud backup restore job using the Atlas CLI with options for cluster name, output format, and project ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-restores-watch.txt b/source/command/atlas-backups-restores-watch.txt index 62e91e94..c0f54034 100644 --- a/source/command/atlas-backups-restores-watch.txt +++ b/source/command/atlas-backups-restores-watch.txt @@ -4,9 +4,6 @@ atlas backups restores watch ============================ -.. meta:: - :description: Monitor the status of a restore job in Atlas until it completes, fails, or is canceled, using the `atlas backups restores watch` command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-restores.txt b/source/command/atlas-backups-restores.txt index 099d8738..5959488c 100644 --- a/source/command/atlas-backups-restores.txt +++ b/source/command/atlas-backups-restores.txt @@ -4,9 +4,6 @@ atlas backups restores ====================== -.. meta:: - :description: Manage cloud backup restore jobs for your project using various commands to describe, list, start, and watch restore jobs. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-schedule-delete.txt b/source/command/atlas-backups-schedule-delete.txt index 7118a2cf..b78fc1f4 100644 --- a/source/command/atlas-backups-schedule-delete.txt +++ b/source/command/atlas-backups-schedule-delete.txt @@ -4,9 +4,6 @@ atlas backups schedule delete ============================= -.. meta:: - :description: Delete all backup schedules for a specified cluster using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-schedule-describe.txt b/source/command/atlas-backups-schedule-describe.txt index ae4d063e..bc59d347 100644 --- a/source/command/atlas-backups-schedule-describe.txt +++ b/source/command/atlas-backups-schedule-describe.txt @@ -4,9 +4,6 @@ atlas backups schedule describe =============================== -.. meta:: - :description: Describe a cloud backup schedule for a specified cluster using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-schedule-update.txt b/source/command/atlas-backups-schedule-update.txt index ca39dd74..aa99e706 100644 --- a/source/command/atlas-backups-schedule-update.txt +++ b/source/command/atlas-backups-schedule-update.txt @@ -4,9 +4,6 @@ atlas backups schedule update ============================= -.. meta:: - :description: Modify the backup schedule for a specified cluster in your project, defining snapshot timing and retention duration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups-snapshots-create.txt b/source/command/atlas-backups-snapshots-create.txt index bb405f77..a9c24f0a 100644 --- a/source/command/atlas-backups-snapshots-create.txt +++ b/source/command/atlas-backups-snapshots-create.txt @@ -4,9 +4,6 @@ atlas backups snapshots create ============================== -.. meta:: - :description: Create on-demand backup snapshots for Atlas clusters M10 and larger using the CLI command with various options for customization. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-backups.txt b/source/command/atlas-backups.txt index 4009fff0..c04fe26d 100644 --- a/source/command/atlas-backups.txt +++ b/source/command/atlas-backups.txt @@ -4,9 +4,6 @@ atlas backups ============= -.. meta:: - :description: Manage cloud backups for your project using various Atlas CLI commands and options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-cloudProviders.txt b/source/command/atlas-cloudProviders.txt index 8db8e783..397bdf24 100644 --- a/source/command/atlas-cloudProviders.txt +++ b/source/command/atlas-cloudProviders.txt @@ -4,9 +4,6 @@ atlas cloudProviders ==================== -.. meta:: - :description: Manage cloud provider access in Atlas using AWS IAM roles with the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-advancedSettings-describe.txt b/source/command/atlas-clusters-advancedSettings-describe.txt index 0198f5cf..da40aab2 100644 --- a/source/command/atlas-clusters-advancedSettings-describe.txt +++ b/source/command/atlas-clusters-advancedSettings-describe.txt @@ -4,9 +4,6 @@ atlas clusters advancedSettings describe ======================================== -.. meta:: - :description: Retrieve advanced configuration settings for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-advancedSettings-update.txt b/source/command/atlas-clusters-advancedSettings-update.txt index eb48acad..5017e010 100644 --- a/source/command/atlas-clusters-advancedSettings-update.txt +++ b/source/command/atlas-clusters-advancedSettings-update.txt @@ -4,9 +4,6 @@ atlas clusters advancedSettings update ====================================== -.. meta:: - :description: Update advanced configuration settings for a cluster in a specified project, including read/write concern, index limits, and oplog settings, for M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-availableRegions-list.txt b/source/command/atlas-clusters-availableRegions-list.txt index 84c1d941..e0adf92e 100644 --- a/source/command/atlas-clusters-availableRegions-list.txt +++ b/source/command/atlas-clusters-availableRegions-list.txt @@ -4,9 +4,6 @@ atlas clusters availableRegions list ==================================== -.. meta:: - :description: List available regions for new Atlas deployments using the CLI, with options for provider, tier, and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-connectionStrings-describe.txt b/source/command/atlas-clusters-connectionStrings-describe.txt index 0220cf30..92b25f76 100644 --- a/source/command/atlas-clusters-connectionStrings-describe.txt +++ b/source/command/atlas-clusters-connectionStrings-describe.txt @@ -4,9 +4,6 @@ atlas clusters connectionStrings describe ========================================= -.. meta:: - :description: Retrieve the SRV connection string for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-create.txt b/source/command/atlas-clusters-create.txt index 8dcf9156..85bb0364 100644 --- a/source/command/atlas-clusters-create.txt +++ b/source/command/atlas-clusters-create.txt @@ -4,9 +4,6 @@ atlas clusters create ===================== -.. meta:: - :description: Create a cluster in Atlas by specifying a name, cloud provider, and region, or use a JSON configuration file for detailed settings. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-delete.txt b/source/command/atlas-clusters-delete.txt index 213c1d8b..cf9404e9 100644 --- a/source/command/atlas-clusters-delete.txt +++ b/source/command/atlas-clusters-delete.txt @@ -4,9 +4,6 @@ atlas clusters delete ===================== -.. meta:: - :description: Delete a specified cluster from your project using the Atlas CLI, with options for confirmation prompts and backup snapshot removal. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-describe.txt b/source/command/atlas-clusters-describe.txt index fae71df1..859d243f 100644 --- a/source/command/atlas-clusters-describe.txt +++ b/source/command/atlas-clusters-describe.txt @@ -4,9 +4,6 @@ atlas clusters describe ======================= -.. meta:: - :description: Retrieve details of a specified cluster using the Atlas CLI, with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-failover.txt b/source/command/atlas-clusters-failover.txt index bdb24cb6..8d96a5de 100644 --- a/source/command/atlas-clusters-failover.txt +++ b/source/command/atlas-clusters-failover.txt @@ -4,9 +4,6 @@ atlas clusters failover ======================= -.. meta:: - :description: Initiate a failover test for a specified cluster in a project using the Atlas CLI, which involves shutting down the primary node and electing a new one. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-indexes-create.txt b/source/command/atlas-clusters-indexes-create.txt index 3a8edca6..b0ab8cec 100644 --- a/source/command/atlas-clusters-indexes-create.txt +++ b/source/command/atlas-clusters-indexes-create.txt @@ -4,9 +4,6 @@ atlas clusters indexes create ============================= -.. meta:: - :description: Create a rolling index for a specified cluster using the Atlas CLI, with options for cluster name, collection, database, and index configuration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-list.txt b/source/command/atlas-clusters-list.txt index 274c1ef1..4c6815e5 100644 --- a/source/command/atlas-clusters-list.txt +++ b/source/command/atlas-clusters-list.txt @@ -4,9 +4,6 @@ atlas clusters list =================== -.. meta:: - :description: List all clusters in your project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-onlineArchives-create.txt b/source/command/atlas-clusters-onlineArchives-create.txt index 8c7a707e..807caab5 100644 --- a/source/command/atlas-clusters-onlineArchives-create.txt +++ b/source/command/atlas-clusters-onlineArchives-create.txt @@ -4,9 +4,6 @@ atlas clusters onlineArchives create ==================================== -.. meta:: - :description: Create an online archive for a collection in a specified cluster using the Atlas CLI, with options for configuration and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-onlineArchives-update.txt b/source/command/atlas-clusters-onlineArchives-update.txt index 9a696414..53ee303d 100644 --- a/source/command/atlas-clusters-onlineArchives-update.txt +++ b/source/command/atlas-clusters-onlineArchives-update.txt @@ -4,9 +4,6 @@ atlas clusters onlineArchives update ==================================== -.. meta:: - :description: Update the archiving rule for an online archive in a cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-pause.txt b/source/command/atlas-clusters-pause.txt index 98c83ac9..6f369603 100644 --- a/source/command/atlas-clusters-pause.txt +++ b/source/command/atlas-clusters-pause.txt @@ -4,9 +4,6 @@ atlas clusters pause ==================== -.. meta:: - :description: Pause a running cluster in Atlas using the CLI, requiring authentication and applicable to M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-sampleData-describe.txt b/source/command/atlas-clusters-sampleData-describe.txt index a4e16432..4582679f 100644 --- a/source/command/atlas-clusters-sampleData-describe.txt +++ b/source/command/atlas-clusters-sampleData-describe.txt @@ -4,9 +4,6 @@ atlas clusters sampleData describe ================================== -.. meta:: - :description: Retrieve details of a sample data load job using the Atlas CLI command with specified options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-sampleData-load.txt b/source/command/atlas-clusters-sampleData-load.txt index 9bac2d5f..89f96848 100644 --- a/source/command/atlas-clusters-sampleData-load.txt +++ b/source/command/atlas-clusters-sampleData-load.txt @@ -4,9 +4,6 @@ atlas clusters sampleData load ============================== -.. meta:: - :description: Load sample data into a specified Atlas cluster using the CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-sampleData-watch.txt b/source/command/atlas-clusters-sampleData-watch.txt index b8808c5e..6999b018 100644 --- a/source/command/atlas-clusters-sampleData-watch.txt +++ b/source/command/atlas-clusters-sampleData-watch.txt @@ -4,9 +4,6 @@ atlas clusters sampleData watch =============================== -.. meta:: - :description: Monitor the status of a sample data job in your cluster until it completes using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-sampleData.txt b/source/command/atlas-clusters-sampleData.txt index a848c8b1..60fb5978 100644 --- a/source/command/atlas-clusters-sampleData.txt +++ b/source/command/atlas-clusters-sampleData.txt @@ -4,9 +4,6 @@ atlas clusters sampleData ========================= -.. meta:: - :description: Access and manage sample data for your cluster using the sampleData command in the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-indexes-create.txt b/source/command/atlas-clusters-search-indexes-create.txt index f305ccfd..798abf7b 100644 --- a/source/command/atlas-clusters-search-indexes-create.txt +++ b/source/command/atlas-clusters-search-indexes-create.txt @@ -4,9 +4,6 @@ atlas clusters search indexes create ==================================== -.. meta:: - :description: Create a search index for a cluster using the Atlas CLI, specifying options like cluster name and index configuration file. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-indexes-describe.txt b/source/command/atlas-clusters-search-indexes-describe.txt index fa3ef828..eef63fa8 100644 --- a/source/command/atlas-clusters-search-indexes-describe.txt +++ b/source/command/atlas-clusters-search-indexes-describe.txt @@ -4,9 +4,6 @@ atlas clusters search indexes describe ====================================== -.. meta:: - :description: Retrieve details of a search index for a cluster using the Atlas CLI, requiring authentication and specifying the index ID and cluster name. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-indexes-list.txt b/source/command/atlas-clusters-search-indexes-list.txt index 0a899056..e17eb4d2 100644 --- a/source/command/atlas-clusters-search-indexes-list.txt +++ b/source/command/atlas-clusters-search-indexes-list.txt @@ -4,9 +4,6 @@ atlas clusters search indexes list ================================== -.. meta:: - :description: List all Atlas Search indexes for a cluster using the Atlas CLI, specifying cluster, database, and collection names. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-nodes-create.txt b/source/command/atlas-clusters-search-nodes-create.txt index 74416ee4..b60cc0fa 100644 --- a/source/command/atlas-clusters-search-nodes-create.txt +++ b/source/command/atlas-clusters-search-nodes-create.txt @@ -4,9 +4,6 @@ atlas clusters search nodes create ================================== -.. meta:: - :description: Create a search node for a cluster using the Atlas CLI, requiring authentication and specifying options like cluster name and configuration file. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-nodes-delete.txt b/source/command/atlas-clusters-search-nodes-delete.txt index 95fe6080..fff98326 100644 --- a/source/command/atlas-clusters-search-nodes-delete.txt +++ b/source/command/atlas-clusters-search-nodes-delete.txt @@ -4,9 +4,6 @@ atlas clusters search nodes delete ================================== -.. meta:: - :description: Delete a search node from a cluster using the Atlas CLI, requiring authentication and cluster name specification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-nodes-list.txt b/source/command/atlas-clusters-search-nodes-list.txt index 2f896a7d..c0d34601 100644 --- a/source/command/atlas-clusters-search-nodes-list.txt +++ b/source/command/atlas-clusters-search-nodes-list.txt @@ -4,9 +4,6 @@ atlas clusters search nodes list ================================ -.. meta:: - :description: List Atlas Search nodes for a cluster using the CLI, requiring authentication and specifying cluster name and output format options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search-nodes-update.txt b/source/command/atlas-clusters-search-nodes-update.txt index 6fe83872..bab41d62 100644 --- a/source/command/atlas-clusters-search-nodes-update.txt +++ b/source/command/atlas-clusters-search-nodes-update.txt @@ -4,9 +4,6 @@ atlas clusters search nodes update ================================== -.. meta:: - :description: Update a search node for a cluster using the Atlas CLI with options for cluster name, configuration file, and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-search.txt b/source/command/atlas-clusters-search.txt index 9f636d47..d8ffd2b0 100644 --- a/source/command/atlas-clusters-search.txt +++ b/source/command/atlas-clusters-search.txt @@ -4,9 +4,6 @@ atlas clusters search ===================== -.. meta:: - :description: Manage Atlas Search for your cluster using the Atlas CLI with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-start.txt b/source/command/atlas-clusters-start.txt index 039a77aa..943c8f07 100644 --- a/source/command/atlas-clusters-start.txt +++ b/source/command/atlas-clusters-start.txt @@ -4,9 +4,6 @@ atlas clusters start ==================== -.. meta:: - :description: Start a paused MongoDB cluster using the Atlas CLI, requiring authentication and supporting M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-update.txt b/source/command/atlas-clusters-update.txt index 05edae0f..3275c92b 100644 --- a/source/command/atlas-clusters-update.txt +++ b/source/command/atlas-clusters-update.txt @@ -4,9 +4,6 @@ atlas clusters update ===================== -.. meta:: - :description: Modify cluster settings using the Atlas CLI, with options for JSON configuration files, tier updates, and termination protection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-upgrade.txt b/source/command/atlas-clusters-upgrade.txt index c0a6836f..59b913b5 100644 --- a/source/command/atlas-clusters-upgrade.txt +++ b/source/command/atlas-clusters-upgrade.txt @@ -4,9 +4,6 @@ atlas clusters upgrade ====================== -.. meta:: - :description: Upgrade a shared cluster's tier, disk size, or MongoDB version using the Atlas CLI, with options for termination protection and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters-watch.txt b/source/command/atlas-clusters-watch.txt index d6a03b93..9370e546 100644 --- a/source/command/atlas-clusters-watch.txt +++ b/source/command/atlas-clusters-watch.txt @@ -4,9 +4,6 @@ atlas clusters watch ==================== -.. meta:: - :description: Monitor a specified cluster's status until it becomes available using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-clusters.txt b/source/command/atlas-clusters.txt index 871df3ee..5f49f0d4 100644 --- a/source/command/atlas-clusters.txt +++ b/source/command/atlas-clusters.txt @@ -4,9 +4,6 @@ atlas clusters ============== -.. meta:: - :description: Manage and configure clusters in your project using the Atlas CLI, including creating, editing, and deleting clusters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-completion-bash.txt b/source/command/atlas-completion-bash.txt index 46b3f506..14d36aab 100644 --- a/source/command/atlas-completion-bash.txt +++ b/source/command/atlas-completion-bash.txt @@ -4,9 +4,6 @@ atlas completion bash ===================== -.. meta:: - :description: Generate a bash autocompletion script for Atlas CLI, requiring the 'bash-completion' package and providing options for setup. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-completion.txt b/source/command/atlas-completion.txt index 7fad5464..57d74af2 100644 --- a/source/command/atlas-completion.txt +++ b/source/command/atlas-completion.txt @@ -4,9 +4,6 @@ atlas completion ================ -.. meta:: - :description: Generate autocompletion scripts for Atlas CLI in various shells, including bash, fish, powershell, and zsh. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-config-describe.txt b/source/command/atlas-config-describe.txt index 1b8d013b..56359f18 100644 --- a/source/command/atlas-config-describe.txt +++ b/source/command/atlas-config-describe.txt @@ -4,9 +4,6 @@ atlas config describe ===================== -.. meta:: - :description: Retrieve a specified profile using the "atlas config describe" command with options for output format and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-config-edit.txt b/source/command/atlas-config-edit.txt index 880f8f54..3f79872c 100644 --- a/source/command/atlas-config-edit.txt +++ b/source/command/atlas-config-edit.txt @@ -4,9 +4,6 @@ atlas config edit ================= -.. meta:: - :description: Open the Atlas CLI config file using the default text editor, with options to change the editor via environment variables. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-config-init.txt b/source/command/atlas-config-init.txt index a9074d51..5869b383 100644 --- a/source/command/atlas-config-init.txt +++ b/source/command/atlas-config-init.txt @@ -4,9 +4,6 @@ atlas config init ================= -.. meta:: - :description: Configure a profile to store access settings for your MongoDB deployment using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-config-list.txt b/source/command/atlas-config-list.txt index 2f1a7520..36cee08a 100644 --- a/source/command/atlas-config-list.txt +++ b/source/command/atlas-config-list.txt @@ -4,9 +4,6 @@ atlas config list ================= -.. meta:: - :description: List available profiles by name using the Atlas CLI, with options for output format and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-config.txt b/source/command/atlas-config.txt index b1b9d49a..407faf6a 100644 --- a/source/command/atlas-config.txt +++ b/source/command/atlas-config.txt @@ -4,9 +4,6 @@ atlas config ============ -.. meta:: - :description: Manage and configure user profiles in Atlas CLI, including setting options and using environment variables. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles-create.txt b/source/command/atlas-customDbRoles-create.txt index 9b9a0e32..9b8a2159 100644 --- a/source/command/atlas-customDbRoles-create.txt +++ b/source/command/atlas-customDbRoles-create.txt @@ -4,9 +4,6 @@ atlas customDbRoles create ========================== -.. meta:: - :description: Create a custom database role in your project using the Atlas CLI, specifying role name, privileges, and optional inherited roles. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles-delete.txt b/source/command/atlas-customDbRoles-delete.txt index 7eb58850..15ac1aa8 100644 --- a/source/command/atlas-customDbRoles-delete.txt +++ b/source/command/atlas-customDbRoles-delete.txt @@ -4,9 +4,6 @@ atlas customDbRoles delete ========================== -.. meta:: - :description: Remove a custom database role from your Atlas project using the CLI command with options for force and project ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles-describe.txt b/source/command/atlas-customDbRoles-describe.txt index b0a09e86..fc55e026 100644 --- a/source/command/atlas-customDbRoles-describe.txt +++ b/source/command/atlas-customDbRoles-describe.txt @@ -4,9 +4,6 @@ atlas customDbRoles describe ============================ -.. meta:: - :description: Retrieve details of a custom database role in your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles-list.txt b/source/command/atlas-customDbRoles-list.txt index b3eae042..68e8f8d5 100644 --- a/source/command/atlas-customDbRoles-list.txt +++ b/source/command/atlas-customDbRoles-list.txt @@ -4,9 +4,6 @@ atlas customDbRoles list ======================== -.. meta:: - :description: List custom database roles for your project using the Atlas CLI command with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles-update.txt b/source/command/atlas-customDbRoles-update.txt index 94e2881d..eb665640 100644 --- a/source/command/atlas-customDbRoles-update.txt +++ b/source/command/atlas-customDbRoles-update.txt @@ -4,9 +4,6 @@ atlas customDbRoles update ========================== -.. meta:: - :description: Update a custom database role in your project using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDbRoles.txt b/source/command/atlas-customDbRoles.txt index cb648c51..674eaa62 100644 --- a/source/command/atlas-customDbRoles.txt +++ b/source/command/atlas-customDbRoles.txt @@ -4,9 +4,6 @@ atlas customDbRoles =================== -.. meta:: - :description: Manage custom database roles in your project using the Atlas CLI, including creating, deleting, and updating roles. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-customDns.txt b/source/command/atlas-customDns.txt index 8e24c536..a613a48d 100644 --- a/source/command/atlas-customDns.txt +++ b/source/command/atlas-customDns.txt @@ -4,9 +4,6 @@ atlas customDns =============== -.. meta:: - :description: Manage DNS configuration for Atlas project clusters deployed on AWS using the customDns command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-create.txt b/source/command/atlas-dataFederation-create.txt index 08f84745..cb56350e 100644 --- a/source/command/atlas-dataFederation-create.txt +++ b/source/command/atlas-dataFederation-create.txt @@ -4,9 +4,6 @@ atlas dataFederation create =========================== -.. meta:: - :description: Create a new Data Federation database using the Atlas CLI with options for AWS role, S3 bucket, and region settings. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-logs.txt b/source/command/atlas-dataFederation-logs.txt index e10987a0..708beaf6 100644 --- a/source/command/atlas-dataFederation-logs.txt +++ b/source/command/atlas-dataFederation-logs.txt @@ -4,9 +4,6 @@ atlas dataFederation logs ========================= -.. meta:: - :description: Retrieve logs for a specified data federation database using the Atlas CLI, requiring authentication with a user account or API key. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-privateEndpoints.txt b/source/command/atlas-dataFederation-privateEndpoints.txt index 18ebd770..2bb92609 100644 --- a/source/command/atlas-dataFederation-privateEndpoints.txt +++ b/source/command/atlas-dataFederation-privateEndpoints.txt @@ -4,9 +4,6 @@ atlas dataFederation privateEndpoints ===================================== -.. meta:: - :description: Manage Data Federation private endpoints with commands to create, delete, describe, and list endpoints in your project. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-queryLimits-create.txt b/source/command/atlas-dataFederation-queryLimits-create.txt index 32effedd..eaa5f1f2 100644 --- a/source/command/atlas-dataFederation-queryLimits-create.txt +++ b/source/command/atlas-dataFederation-queryLimits-create.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits create ======================================= -.. meta:: - :description: Create a new Data Federation query limit using the Atlas CLI with specified options and arguments. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-queryLimits-delete.txt b/source/command/atlas-dataFederation-queryLimits-delete.txt index 305427c4..3291c783 100644 --- a/source/command/atlas-dataFederation-queryLimits-delete.txt +++ b/source/command/atlas-dataFederation-queryLimits-delete.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits delete ======================================= -.. meta:: - :description: Remove a specified data federation query limit from your project using the Atlas CLI with authentication and necessary options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-queryLimits-describe.txt b/source/command/atlas-dataFederation-queryLimits-describe.txt index 5319afc2..63f1b1b2 100644 --- a/source/command/atlas-dataFederation-queryLimits-describe.txt +++ b/source/command/atlas-dataFederation-queryLimits-describe.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits describe ========================================= -.. meta:: - :description: Retrieve details of a specified data federation query limit using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-queryLimits-list.txt b/source/command/atlas-dataFederation-queryLimits-list.txt index 384dc223..9f302323 100644 --- a/source/command/atlas-dataFederation-queryLimits-list.txt +++ b/source/command/atlas-dataFederation-queryLimits-list.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits list ===================================== -.. meta:: - :description: List all data federation query limits for your project using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation-queryLimits.txt b/source/command/atlas-dataFederation-queryLimits.txt index ff23d7cb..9667d5ed 100644 --- a/source/command/atlas-dataFederation-queryLimits.txt +++ b/source/command/atlas-dataFederation-queryLimits.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits ================================ -.. meta:: - :description: Explore and manage data federation query limits with commands to create, delete, describe, and list limits in your project. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dataFederation.txt b/source/command/atlas-dataFederation.txt index 2d04c689..f548e434 100644 --- a/source/command/atlas-dataFederation.txt +++ b/source/command/atlas-dataFederation.txt @@ -4,9 +4,6 @@ atlas dataFederation ==================== -.. meta:: - :description: Explore commands for managing Data Federation databases in Atlas, including creation, deletion, and querying. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-certs-create.txt b/source/command/atlas-dbusers-certs-create.txt index e103f969..a5771b97 100644 --- a/source/command/atlas-dbusers-certs-create.txt +++ b/source/command/atlas-dbusers-certs-create.txt @@ -4,9 +4,6 @@ atlas dbusers certs create ========================== -.. meta:: - :description: Create an Atlas-managed X.509 certificate for a database user, specifying expiration and output options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-certs-list.txt b/source/command/atlas-dbusers-certs-list.txt index c57917be..03952ae8 100644 --- a/source/command/atlas-dbusers-certs-list.txt +++ b/source/command/atlas-dbusers-certs-list.txt @@ -4,9 +4,6 @@ atlas dbusers certs list ======================== -.. meta:: - :description: List all unexpired Atlas-managed X.509 certificates for a specified database user using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-create.txt b/source/command/atlas-dbusers-create.txt index 7dae5c31..53cf35d0 100644 --- a/source/command/atlas-dbusers-create.txt +++ b/source/command/atlas-dbusers-create.txt @@ -4,9 +4,6 @@ atlas dbusers create ==================== -.. meta:: - :description: Create a database user in Atlas with various authentication methods and roles using the CLI command `atlas dbusers create`. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-delete.txt b/source/command/atlas-dbusers-delete.txt index 24611616..78e7aec1 100644 --- a/source/command/atlas-dbusers-delete.txt +++ b/source/command/atlas-dbusers-delete.txt @@ -4,9 +4,6 @@ atlas dbusers delete ==================== -.. meta:: - :description: Remove a specified database user from your project using the Atlas CLI with options for authentication and project identification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-describe.txt b/source/command/atlas-dbusers-describe.txt index f9d4d0fd..275db941 100644 --- a/source/command/atlas-dbusers-describe.txt +++ b/source/command/atlas-dbusers-describe.txt @@ -4,9 +4,6 @@ atlas dbusers describe ====================== -.. meta:: - :description: Retrieve details of a specified database user in your project using the Atlas CLI command `atlas dbusers describe`. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-list.txt b/source/command/atlas-dbusers-list.txt index 1ad39381..cebb33b6 100644 --- a/source/command/atlas-dbusers-list.txt +++ b/source/command/atlas-dbusers-list.txt @@ -4,9 +4,6 @@ atlas dbusers list ================== -.. meta:: - :description: List all database users for your project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers-update.txt b/source/command/atlas-dbusers-update.txt index 897d764b..55583100 100644 --- a/source/command/atlas-dbusers-update.txt +++ b/source/command/atlas-dbusers-update.txt @@ -4,9 +4,6 @@ atlas dbusers update ==================== -.. meta:: - :description: Update database user details in your project using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-dbusers.txt b/source/command/atlas-dbusers.txt index b5be3a30..bf2938b9 100644 --- a/source/command/atlas-dbusers.txt +++ b/source/command/atlas-dbusers.txt @@ -4,9 +4,6 @@ atlas dbusers ============= -.. meta:: - :description: Manage database users in your project with the dbusers command, including retrieval, creation, and modification of user roles across clusters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-connect.txt b/source/command/atlas-deployments-connect.txt index a8fa47dc..ba7a01e1 100644 --- a/source/command/atlas-deployments-connect.txt +++ b/source/command/atlas-deployments-connect.txt @@ -4,9 +4,6 @@ atlas deployments connect ========================= -.. meta:: - :description: Connect to a local or Atlas deployment using various methods and options, including specifying connection type and authentication credentials. - .. default-domain:: mongodb .. contents:: On this page @@ -57,7 +54,7 @@ Options * - --connectWith - string - false - - Method for connecting to the deployment. Valid values are compass, connectionString and mongosh. + - Method for connecting to the deployment. Valid values are compass, connectionString, mongosh, and vscode. * - --connectionStringType - string - false diff --git a/source/command/atlas-deployments-delete.txt b/source/command/atlas-deployments-delete.txt index c5045c6a..7da47cba 100644 --- a/source/command/atlas-deployments-delete.txt +++ b/source/command/atlas-deployments-delete.txt @@ -18,6 +18,7 @@ The command prompts you to confirm the operation when you run the command withou Deleting an Atlas deployment also deletes any backup snapshots for that cluster. Deleting a Local deployment also deletes any local data volumes. +Deleting a deployment will not remove saved connections from MongoDB for VS Code. This must be done manually. To learn more, see https://www.mongodb.com/docs/mongodb-vscode/connect/#remove-a-connection. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-deployments-list.txt b/source/command/atlas-deployments-list.txt index aeeb077e..6cd45921 100644 --- a/source/command/atlas-deployments-list.txt +++ b/source/command/atlas-deployments-list.txt @@ -4,9 +4,6 @@ atlas deployments list ====================== -.. meta:: - :description: List all Atlas deployments using the CLI, with options for project ID and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-logs.txt b/source/command/atlas-deployments-logs.txt index 70955b5c..9d4c8896 100644 --- a/source/command/atlas-deployments-logs.txt +++ b/source/command/atlas-deployments-logs.txt @@ -4,9 +4,6 @@ atlas deployments logs ====================== -.. meta:: - :description: Retrieve deployment logs using various options like deployment name, host, and log file name. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-pause.txt b/source/command/atlas-deployments-pause.txt index aa73bdb3..0508178d 100644 --- a/source/command/atlas-deployments-pause.txt +++ b/source/command/atlas-deployments-pause.txt @@ -4,9 +4,6 @@ atlas deployments pause ======================= -.. meta:: - :description: Pause a deployment using the Atlas CLI with options for specifying project ID, deployment type, and configuration profile. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-search-indexes-create.txt b/source/command/atlas-deployments-search-indexes-create.txt index 06d2cc09..6948f1a1 100644 --- a/source/command/atlas-deployments-search-indexes-create.txt +++ b/source/command/atlas-deployments-search-indexes-create.txt @@ -4,9 +4,6 @@ atlas deployments search indexes create ======================================= -.. meta:: - :description: Create a search index for a specified deployment using various options like collection, database, and configuration file. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-search-indexes-delete.txt b/source/command/atlas-deployments-search-indexes-delete.txt index c444211e..49f5287e 100644 --- a/source/command/atlas-deployments-search-indexes-delete.txt +++ b/source/command/atlas-deployments-search-indexes-delete.txt @@ -4,9 +4,6 @@ atlas deployments search indexes delete ======================================= -.. meta:: - :description: Delete a specified search index from a deployment using the Atlas CLI command with various options for customization. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-search-indexes-describe.txt b/source/command/atlas-deployments-search-indexes-describe.txt index a7e48835..fef7fb2e 100644 --- a/source/command/atlas-deployments-search-indexes-describe.txt +++ b/source/command/atlas-deployments-search-indexes-describe.txt @@ -4,9 +4,6 @@ atlas deployments search indexes describe ========================================= -.. meta:: - :description: Describe a search index for a specified deployment using the Atlas CLI command with various options for output and authentication. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-search-indexes-list.txt b/source/command/atlas-deployments-search-indexes-list.txt index 926653e7..75ba7080 100644 --- a/source/command/atlas-deployments-search-indexes-list.txt +++ b/source/command/atlas-deployments-search-indexes-list.txt @@ -4,9 +4,6 @@ atlas deployments search indexes list ===================================== -.. meta:: - :description: List all Atlas Search indexes for a deployment using the Atlas CLI with various options for filtering and output formatting. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments-setup.txt b/source/command/atlas-deployments-setup.txt index 56128cbf..b492957b 100644 --- a/source/command/atlas-deployments-setup.txt +++ b/source/command/atlas-deployments-setup.txt @@ -4,9 +4,6 @@ atlas deployments setup ======================= -.. meta:: - :description: Set up a local deployment using the Atlas CLI with customizable options for IP access, connection method, and deployment type. - .. default-domain:: mongodb .. contents:: On this page @@ -69,7 +66,7 @@ Options * - --connectWith - string - false - - Method for connecting to the deployment. Valid values are compass, mongosh and skip. + - Method for connecting to the deployment. Valid values are compass, mongosh, vscode, and skip. Mutually exclusive with --skipMongosh. * - --currentIp diff --git a/source/command/atlas-deployments-start.txt b/source/command/atlas-deployments-start.txt index 4837b137..803e81ad 100644 --- a/source/command/atlas-deployments-start.txt +++ b/source/command/atlas-deployments-start.txt @@ -4,9 +4,6 @@ atlas deployments start ======================= -.. meta:: - :description: Start a deployment using the Atlas CLI with options for specifying project ID, deployment type, and configuration profile. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-deployments.txt b/source/command/atlas-deployments.txt index c6487604..fea6b69c 100644 --- a/source/command/atlas-deployments.txt +++ b/source/command/atlas-deployments.txt @@ -4,9 +4,6 @@ atlas deployments ================= -.. meta:: - :description: Manage cloud and local deployments using Atlas CLI commands for connecting, deleting, listing, pausing, and starting deployments. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-events-organizations-list.txt b/source/command/atlas-events-organizations-list.txt index 0e01521a..86fc6039 100644 --- a/source/command/atlas-events-organizations-list.txt +++ b/source/command/atlas-events-organizations-list.txt @@ -4,9 +4,6 @@ atlas events organizations list =============================== -.. meta:: - :description: List events for a specified organization using various options like date range, output format, and event type. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-events-projects-list.txt b/source/command/atlas-events-projects-list.txt index 800d870c..06ea1ee4 100644 --- a/source/command/atlas-events-projects-list.txt +++ b/source/command/atlas-events-projects-list.txt @@ -4,9 +4,6 @@ atlas events projects list ========================== -.. meta:: - :description: List all events for a specified project using various options like date range, output format, and event type. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-events.txt b/source/command/atlas-events.txt index 4191be55..83e44e0a 100644 --- a/source/command/atlas-events.txt +++ b/source/command/atlas-events.txt @@ -4,9 +4,6 @@ atlas events ============ -.. meta:: - :description: Manage events for your organization or project using the Atlas CLI with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt index 0976024e..849ea4f6 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs connect ============================================================================ -.. meta:: - :description: Connect an Identity Provider to an Organization using the Atlas CLI with options for federation settings, identity provider ID, and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt index 5822056c..47ac1a50 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs delete =========================================================================== -.. meta:: - :description: Delete a connected organization configuration using the Atlas CLI with options for federation settings ID and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt index b15e0691..0986820f 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs describe ============================================================================= -.. meta:: - :description: Describe a connected organization configuration using the Atlas CLI with options for federation settings and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt index 581075ab..aa8916a3 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect =============================================================================== -.. meta:: - :description: Disconnect an Identity Provider from an Organization using the Atlas CLI with specific options for federation settings and identity provider IDs. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt index f766b5f4..7093c311 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs list ========================================================================= -.. meta:: - :description: List connected organization configurations using the Atlas CLI with options for pagination, output format, and organization ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt index ca82fe96..5f4a07a4 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs update =========================================================================== -.. meta:: - :description: Update a connected organization's configuration in Atlas using federation settings and a JSON file. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt index 5dc4c944..faa2be9d 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings describe ========================================================= -.. meta:: - :description: Retrieve Federation Settings details for an organization using the Atlas CLI command with options for output format and organization ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt index 6d6167ca..26ea30cb 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings identityProvider ================================================================= -.. meta:: - :description: Manage Federated Authentication Identity Providers with options to create, delete, describe, list, revoke JWK, and update providers. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-federatedAuthentication.txt b/source/command/atlas-federatedAuthentication.txt index 21c67567..20e4ac28 100644 --- a/source/command/atlas-federatedAuthentication.txt +++ b/source/command/atlas-federatedAuthentication.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication ============================= -.. meta:: - :description: Manage federated authentication settings in Atlas using the CLI, with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-integrations.txt b/source/command/atlas-integrations.txt index 6850731c..53248389 100644 --- a/source/command/atlas-integrations.txt +++ b/source/command/atlas-integrations.txt @@ -4,9 +4,6 @@ atlas integrations ================== -.. meta:: - :description: Configure third-party integrations for your Atlas project using various command options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-create.txt b/source/command/atlas-liveMigrations-create.txt index 29f48c9a..dbdd664e 100644 --- a/source/command/atlas-liveMigrations-create.txt +++ b/source/command/atlas-liveMigrations-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations create =========================== -.. meta:: - :description: Create a new live migration in Atlas using the CLI with options for source and destination cluster configurations. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-cutover.txt b/source/command/atlas-liveMigrations-cutover.txt index 005844a9..b52d4f9e 100644 --- a/source/command/atlas-liveMigrations-cutover.txt +++ b/source/command/atlas-liveMigrations-cutover.txt @@ -4,9 +4,6 @@ atlas liveMigrations cutover ============================ -.. meta:: - :description: Initiate and confirm the completion of a cutover for a live migration using the Atlas CLI, stopping synchronization with the source cluster. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-describe.txt b/source/command/atlas-liveMigrations-describe.txt index d169557a..2798a011 100644 --- a/source/command/atlas-liveMigrations-describe.txt +++ b/source/command/atlas-liveMigrations-describe.txt @@ -4,9 +4,6 @@ atlas liveMigrations describe ============================= -.. meta:: - :description: Describe a live migration job in Atlas using the `atlas liveMigrations describe` command with required options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-link-create.txt b/source/command/atlas-liveMigrations-link-create.txt index e3abf012..e736135d 100644 --- a/source/command/atlas-liveMigrations-link-create.txt +++ b/source/command/atlas-liveMigrations-link-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations link create ================================ -.. meta:: - :description: Create a link-token for push live migration using the Atlas CLI with customizable options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-link-delete.txt b/source/command/atlas-liveMigrations-link-delete.txt index efc103dc..5b457382 100644 --- a/source/command/atlas-liveMigrations-link-delete.txt +++ b/source/command/atlas-liveMigrations-link-delete.txt @@ -4,9 +4,6 @@ atlas liveMigrations link delete ================================ -.. meta:: - :description: Delete a link-token using the Atlas CLI with options to skip confirmation and specify organization ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-validation-create.txt b/source/command/atlas-liveMigrations-validation-create.txt index 0518468c..f47530b5 100644 --- a/source/command/atlas-liveMigrations-validation-create.txt +++ b/source/command/atlas-liveMigrations-validation-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations validation create ====================================== -.. meta:: - :description: Create a validation request for a push live migration using the Atlas CLI, specifying options like cluster names, migration hosts, and authentication details. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations-validation-describe.txt b/source/command/atlas-liveMigrations-validation-describe.txt index bad62f31..85cf8225 100644 --- a/source/command/atlas-liveMigrations-validation-describe.txt +++ b/source/command/atlas-liveMigrations-validation-describe.txt @@ -4,9 +4,6 @@ atlas liveMigrations validation describe ======================================== -.. meta:: - :description: Describe a validation job for live migrations in Atlas using the CLI command with various output options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-liveMigrations.txt b/source/command/atlas-liveMigrations.txt index a7e820c1..015e1454 100644 --- a/source/command/atlas-liveMigrations.txt +++ b/source/command/atlas-liveMigrations.txt @@ -4,9 +4,6 @@ atlas liveMigrations ==================== -.. meta:: - :description: Manage live migrations to Atlas, including creating, starting cutover, describing jobs, and handling link-tokens and validation. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-logs-download.txt b/source/command/atlas-logs-download.txt index e2641a65..576714f0 100644 --- a/source/command/atlas-logs-download.txt +++ b/source/command/atlas-logs-download.txt @@ -4,9 +4,6 @@ atlas logs download =================== -.. meta:: - :description: Download MongoDB logs from a specified host using the Atlas CLI, with options for decompression, date range, and output file settings. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-logs.txt b/source/command/atlas-logs.txt index dd69f781..36035a51 100644 --- a/source/command/atlas-logs.txt +++ b/source/command/atlas-logs.txt @@ -4,9 +4,6 @@ atlas logs ========== -.. meta:: - :description: Download host logs for your project using the Atlas CLI with options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-maintenanceWindows.txt b/source/command/atlas-maintenanceWindows.txt index 3b0c46c4..fa4ee9c2 100644 --- a/source/command/atlas-maintenanceWindows.txt +++ b/source/command/atlas-maintenanceWindows.txt @@ -4,9 +4,6 @@ atlas maintenanceWindows ======================== -.. meta:: - :description: Manage maintenance windows in Atlas, including options to clear, defer, describe, and update settings for your project. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-metrics-processes.txt b/source/command/atlas-metrics-processes.txt index bd7d9690..9ee270bb 100644 --- a/source/command/atlas-metrics-processes.txt +++ b/source/command/atlas-metrics-processes.txt @@ -4,9 +4,6 @@ atlas metrics processes ======================= -.. meta:: - :description: Retrieve process measurements for a specified host using the Atlas CLI, with options for output format, time period, and more. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-metrics.txt b/source/command/atlas-metrics.txt index b4a6bc06..a1c5aadc 100644 --- a/source/command/atlas-metrics.txt +++ b/source/command/atlas-metrics.txt @@ -4,9 +4,6 @@ atlas metrics ============= -.. meta:: - :description: Retrieve metrics on MongoDB processes using the Atlas CLI with options for profiles and help. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-containers-delete.txt b/source/command/atlas-networking-containers-delete.txt index 38a4df5f..689524ce 100644 --- a/source/command/atlas-networking-containers-delete.txt +++ b/source/command/atlas-networking-containers-delete.txt @@ -4,9 +4,6 @@ atlas networking containers delete ================================== -.. meta:: - :description: Delete a specified network peering container from your Atlas project using the CLI, ensuring no clusters exist in the project. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-containers-list.txt b/source/command/atlas-networking-containers-list.txt index 7525ae94..a8750b67 100644 --- a/source/command/atlas-networking-containers-list.txt +++ b/source/command/atlas-networking-containers-list.txt @@ -4,9 +4,6 @@ atlas networking containers list ================================ -.. meta:: - :description: List all network peering containers for your project using the Atlas CLI, with options for output format, pagination, and provider specification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-create-aws.txt b/source/command/atlas-networking-peering-create-aws.txt index dac2fb7f..111a3de4 100644 --- a/source/command/atlas-networking-peering-create-aws.txt +++ b/source/command/atlas-networking-peering-create-aws.txt @@ -4,9 +4,6 @@ atlas networking peering create aws =================================== -.. meta:: - :description: Create a network peering connection between your AWS VPC and the Atlas VPC using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-create-azure.txt b/source/command/atlas-networking-peering-create-azure.txt index 00ef096a..714d7b51 100644 --- a/source/command/atlas-networking-peering-create-azure.txt +++ b/source/command/atlas-networking-peering-create-azure.txt @@ -4,9 +4,6 @@ atlas networking peering create azure ===================================== -.. meta:: - :description: Create a network peering connection between an Atlas VPC and an Azure VNet using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-create-gcp.txt b/source/command/atlas-networking-peering-create-gcp.txt index 68ee6738..6110e4fc 100644 --- a/source/command/atlas-networking-peering-create-gcp.txt +++ b/source/command/atlas-networking-peering-create-gcp.txt @@ -4,9 +4,6 @@ atlas networking peering create gcp =================================== -.. meta:: - :description: Create a network peering connection between your Atlas VPC and Google Cloud VPC using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-delete.txt b/source/command/atlas-networking-peering-delete.txt index a0c8cb58..ec44e2d0 100644 --- a/source/command/atlas-networking-peering-delete.txt +++ b/source/command/atlas-networking-peering-delete.txt @@ -4,9 +4,6 @@ atlas networking peering delete =============================== -.. meta:: - :description: Remove a specified network peering connection from your project using the Atlas CLI with options for authentication and confirmation prompts. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-list.txt b/source/command/atlas-networking-peering-list.txt index f1e956be..e47c6e08 100644 --- a/source/command/atlas-networking-peering-list.txt +++ b/source/command/atlas-networking-peering-list.txt @@ -4,9 +4,6 @@ atlas networking peering list ============================= -.. meta:: - :description: List network peering connections for your project using the Atlas CLI, with options for output format and pagination. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking-peering-watch.txt b/source/command/atlas-networking-peering-watch.txt index 7339bc2d..7c8e3ec7 100644 --- a/source/command/atlas-networking-peering-watch.txt +++ b/source/command/atlas-networking-peering-watch.txt @@ -4,9 +4,6 @@ atlas networking peering watch ============================== -.. meta:: - :description: Monitor a specified network peering connection in your project until it becomes available using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-networking.txt b/source/command/atlas-networking.txt index 6eb24bfb..e98acb29 100644 --- a/source/command/atlas-networking.txt +++ b/source/command/atlas-networking.txt @@ -4,9 +4,6 @@ atlas networking ================ -.. meta:: - :description: Configure network peering for your Atlas project using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations-apiKeys-accessLists-create.txt b/source/command/atlas-organizations-apiKeys-accessLists-create.txt index c4d2bf34..7ba279ec 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-create.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists create ============================================== -.. meta:: - :description: Create an IP access list entry for your API Key using the Atlas CLI with options for CIDR notation, current IP, and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations-apiKeys-accessLists-delete.txt b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt index 40829b9b..76735790 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists delete ============================================== -.. meta:: - :description: Remove an IP access list entry from your API Key using the Atlas CLI command with authentication and optional parameters. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations-apiKeys-accessLists-list.txt b/source/command/atlas-organizations-apiKeys-accessLists-list.txt index a702ead2..b18ee729 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-list.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists list ============================================ -.. meta:: - :description: Retrieve all IP access list entries for your API Key using the Atlas CLI, with options for output format and pagination. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations-apiKeys-list.txt b/source/command/atlas-organizations-apiKeys-list.txt index 7063d638..5c6d5e54 100644 --- a/source/command/atlas-organizations-apiKeys-list.txt +++ b/source/command/atlas-organizations-apiKeys-list.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys list ================================ -.. meta:: - :description: Retrieve all API keys for your organization using the Atlas CLI with options for output format, pagination, and organization ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations-create.txt b/source/command/atlas-organizations-create.txt index a4060a22..e9fc7d21 100644 --- a/source/command/atlas-organizations-create.txt +++ b/source/command/atlas-organizations-create.txt @@ -4,9 +4,6 @@ atlas organizations create ========================== -.. meta:: - :description: Create an organization in Atlas using the CLI, with options for API key roles, federation settings, and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-organizations.txt b/source/command/atlas-organizations.txt index 14eb45bf..fa2ee1e5 100644 --- a/source/command/atlas-organizations.txt +++ b/source/command/atlas-organizations.txt @@ -4,9 +4,6 @@ atlas organizations =================== -.. meta:: - :description: Manage Atlas organizations by creating, listing, and handling various operations using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-performanceAdvisor-slowQueryLogs.txt b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt index 02fbbab1..55a1fb2c 100644 --- a/source/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor slowQueryLogs ====================================== -.. meta:: - :description: Retrieve log lines for slow queries on a specified host using the Atlas Performance Advisor. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt index a0e2a276..bcf0b527 100644 --- a/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor suggestedIndexes list ============================================== -.. meta:: - :description: Retrieve suggested indexes to optimize query performance for collections with slow queries using the Performance Advisor. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-performanceAdvisor.txt b/source/command/atlas-performanceAdvisor.txt index f52f2347..4428b2f1 100644 --- a/source/command/atlas-performanceAdvisor.txt +++ b/source/command/atlas-performanceAdvisor.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor ======================== -.. meta:: - :description: Explore slow queries and receive suggestions to enhance database performance using the Atlas Performance Advisor command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints-aws-describe.txt b/source/command/atlas-privateEndpoints-aws-describe.txt index aa7a2433..73d6bc46 100644 --- a/source/command/atlas-privateEndpoints-aws-describe.txt +++ b/source/command/atlas-privateEndpoints-aws-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints aws describe =================================== -.. meta:: - :description: Retrieve details of AWS private endpoints in your project using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt index 886da083..bd17506a 100644 --- a/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints azure interfaces describe ================================================ -.. meta:: - :description: Retrieve details of a specified Azure private endpoint interface using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints-regionalModes-describe.txt b/source/command/atlas-privateEndpoints-regionalModes-describe.txt index ae3d9f7d..f378aad6 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-describe.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes describe ============================================= -.. meta:: - :description: Check the regionalized private endpoint setting for your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints-regionalModes-disable.txt b/source/command/atlas-privateEndpoints-regionalModes-disable.txt index 77c5a220..22b38a3e 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-disable.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes disable ============================================ -.. meta:: - :description: Disable the regionalized private endpoint setting for a project in Atlas, requiring Project Owner role authentication. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints-regionalModes-enable.txt b/source/command/atlas-privateEndpoints-regionalModes-enable.txt index a2108f41..e7caddbb 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-enable.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes enable =========================================== -.. meta:: - :description: Enable regionalized private endpoint settings in your project to create multiple private resources per region across cloud providers. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-privateEndpoints.txt b/source/command/atlas-privateEndpoints.txt index eb0931fd..8a05ab21 100644 --- a/source/command/atlas-privateEndpoints.txt +++ b/source/command/atlas-privateEndpoints.txt @@ -4,9 +4,6 @@ atlas privateEndpoints ====================== -.. meta:: - :description: Manage private endpoints in Atlas, including AWS, Azure, and GCP options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-processes-describe.txt b/source/command/atlas-processes-describe.txt index f5a2828c..d96733b3 100644 --- a/source/command/atlas-processes-describe.txt +++ b/source/command/atlas-processes-describe.txt @@ -4,9 +4,6 @@ atlas processes describe ======================== -.. meta:: - :description: Retrieve details of a specific MongoDB process in your Atlas project using the CLI command `atlas processes describe`. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-processes-list.txt b/source/command/atlas-processes-list.txt index e019a654..6f575dfb 100644 --- a/source/command/atlas-processes-list.txt +++ b/source/command/atlas-processes-list.txt @@ -4,9 +4,6 @@ atlas processes list ==================== -.. meta:: - :description: List all MongoDB processes for your project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-processes.txt b/source/command/atlas-processes.txt index ab19fbcb..5fd7e81a 100644 --- a/source/command/atlas-processes.txt +++ b/source/command/atlas-processes.txt @@ -4,9 +4,6 @@ atlas processes =============== -.. meta:: - :description: Manage MongoDB processes for your project using the Atlas CLI, with options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-apiKeys-delete.txt b/source/command/atlas-projects-apiKeys-delete.txt index e9df98b7..c2b2fbc7 100644 --- a/source/command/atlas-projects-apiKeys-delete.txt +++ b/source/command/atlas-projects-apiKeys-delete.txt @@ -4,9 +4,6 @@ atlas projects apiKeys delete ============================= -.. meta:: - :description: Remove an organization API key from a project using the Atlas CLI command `atlas projects apiKeys delete`. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-apiKeys-list.txt b/source/command/atlas-projects-apiKeys-list.txt index c4b06853..4f260946 100644 --- a/source/command/atlas-projects-apiKeys-list.txt +++ b/source/command/atlas-projects-apiKeys-list.txt @@ -4,9 +4,6 @@ atlas projects apiKeys list =========================== -.. meta:: - :description: List all organization API keys assigned to a project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-create.txt b/source/command/atlas-projects-create.txt index 4b7609f9..2fa91868 100644 --- a/source/command/atlas-projects-create.txt +++ b/source/command/atlas-projects-create.txt @@ -4,9 +4,6 @@ atlas projects create ===================== -.. meta:: - :description: Create a project in your organization using the Atlas CLI, with options for region, output format, and alert settings. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-list.txt b/source/command/atlas-projects-list.txt index c83d0a8f..d34deeb0 100644 --- a/source/command/atlas-projects-list.txt +++ b/source/command/atlas-projects-list.txt @@ -4,9 +4,6 @@ atlas projects list =================== -.. meta:: - :description: List all projects using the Atlas CLI with options for output format, pagination, and organization ID. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-settings-describe.txt b/source/command/atlas-projects-settings-describe.txt index 42972b04..a69830c3 100644 --- a/source/command/atlas-projects-settings-describe.txt +++ b/source/command/atlas-projects-settings-describe.txt @@ -4,9 +4,6 @@ atlas projects settings describe ================================ -.. meta:: - :description: Retrieve project settings details using the Atlas CLI with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-settings-update.txt b/source/command/atlas-projects-settings-update.txt index a2018163..3a8fe62e 100644 --- a/source/command/atlas-projects-settings-update.txt +++ b/source/command/atlas-projects-settings-update.txt @@ -4,9 +4,6 @@ atlas projects settings update ============================== -.. meta:: - :description: Update project settings in Atlas using various flags to enable or disable specific features. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-update.txt b/source/command/atlas-projects-update.txt index 88397c26..3c037c15 100644 --- a/source/command/atlas-projects-update.txt +++ b/source/command/atlas-projects-update.txt @@ -4,9 +4,6 @@ atlas projects update ===================== -.. meta:: - :description: Update a project in Atlas using the CLI with options for configuration file and output format. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects-users-list.txt b/source/command/atlas-projects-users-list.txt index 8c446bcb..fda0542d 100644 --- a/source/command/atlas-projects-users-list.txt +++ b/source/command/atlas-projects-users-list.txt @@ -4,9 +4,6 @@ atlas projects users list ========================= -.. meta:: - :description: List all users for a specified project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-projects.txt b/source/command/atlas-projects.txt index bc9dab84..b7e58250 100644 --- a/source/command/atlas-projects.txt +++ b/source/command/atlas-projects.txt @@ -4,9 +4,6 @@ atlas projects ============== -.. meta:: - :description: Manage Atlas projects with commands to create, list, update, and delete projects, and handle API keys, settings, teams, and users. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-security-customerCerts-create.txt b/source/command/atlas-security-customerCerts-create.txt index 2b6ad22c..f22030f1 100644 --- a/source/command/atlas-security-customerCerts-create.txt +++ b/source/command/atlas-security-customerCerts-create.txt @@ -4,9 +4,6 @@ atlas security customerCerts create =================================== -.. meta:: - :description: Save a customer-managed X.509 configuration for your project using the Atlas CLI, triggering a rolling restart. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-security-customerCerts-describe.txt b/source/command/atlas-security-customerCerts-describe.txt index f1285240..c94b4cad 100644 --- a/source/command/atlas-security-customerCerts-describe.txt +++ b/source/command/atlas-security-customerCerts-describe.txt @@ -4,9 +4,6 @@ atlas security customerCerts describe ===================================== -.. meta:: - :description: Retrieve details of the customer-managed X.509 configuration for your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-security-customerCerts-disable.txt b/source/command/atlas-security-customerCerts-disable.txt index dcc41204..c45f4712 100644 --- a/source/command/atlas-security-customerCerts-disable.txt +++ b/source/command/atlas-security-customerCerts-disable.txt @@ -4,9 +4,6 @@ atlas security customerCerts disable ==================================== -.. meta:: - :description: Disable customer-managed X.509 settings on a project, including the Certificate Authority, using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-security.txt b/source/command/atlas-security.txt index 50d02b64..3457b587 100644 --- a/source/command/atlas-security.txt +++ b/source/command/atlas-security.txt @@ -4,9 +4,6 @@ atlas security ============== -.. meta:: - :description: Manage security configurations for your project using the Atlas CLI, including options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-setup.txt b/source/command/atlas-setup.txt index 204a47ac..f22446e8 100644 --- a/source/command/atlas-setup.txt +++ b/source/command/atlas-setup.txt @@ -4,9 +4,6 @@ atlas setup =========== -.. meta:: - :description: Set up an Atlas cluster by registering, authenticating, creating, and accessing it using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -53,7 +50,7 @@ Options * - --connectWith - string - false - - Method for connecting to the cluster. Valid values are compass, mongosh and skip. + - Method for connecting to the cluster. Valid values are compass, mongosh, vscode and skip. Mutually exclusive with --skipMongosh. * - --currentIp diff --git a/source/command/atlas-streams-instances-create.txt b/source/command/atlas-streams-instances-create.txt index d3058770..7b3f705d 100644 --- a/source/command/atlas-streams-instances-create.txt +++ b/source/command/atlas-streams-instances-create.txt @@ -4,9 +4,6 @@ atlas streams instances create ============================== -.. meta:: - :description: Create an Atlas Stream Processing instance by specifying a name, cloud provider, and region, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-streams.txt b/source/command/atlas-streams.txt index 03525f5b..d0a648ba 100644 --- a/source/command/atlas-streams.txt +++ b/source/command/atlas-streams.txt @@ -4,9 +4,6 @@ atlas streams ============= -.. meta:: - :description: Manage Atlas Stream Processing deployments by creating, editing, and deleting streams, and modifying connection registries. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-teams-list.txt b/source/command/atlas-teams-list.txt index a30efdf9..f454ff67 100644 --- a/source/command/atlas-teams-list.txt +++ b/source/command/atlas-teams-list.txt @@ -4,9 +4,6 @@ atlas teams list ================ -.. meta:: - :description: List all teams in your organization using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-teams.txt b/source/command/atlas-teams.txt index d4d2f99a..a32ada2f 100644 --- a/source/command/atlas-teams.txt +++ b/source/command/atlas-teams.txt @@ -4,9 +4,6 @@ atlas teams =========== -.. meta:: - :description: Manage Atlas teams by creating, listing, renaming, and deleting them using the CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-users-invite.txt b/source/command/atlas-users-invite.txt index 22121894..7b5ebd32 100644 --- a/source/command/atlas-users-invite.txt +++ b/source/command/atlas-users-invite.txt @@ -4,9 +4,6 @@ atlas users invite ================== -.. meta:: - :description: Invite users to your Atlas organizations and projects by creating an Atlas user account with specified roles and permissions. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-users.txt b/source/command/atlas-users.txt index d109974d..7507d266 100644 --- a/source/command/atlas-users.txt +++ b/source/command/atlas-users.txt @@ -4,9 +4,6 @@ atlas users =========== -.. meta:: - :description: Manage Atlas users by creating, describing, and inviting them to organizations and projects using the CLI. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas.txt b/source/command/atlas.txt index d496d854..f6ab91e6 100644 --- a/source/command/atlas.txt +++ b/source/command/atlas.txt @@ -4,9 +4,6 @@ atlas ===== -.. meta:: - :description: Manage MongoDB Atlas deployments and search using the Atlas CLI with intuitive terminal commands. - .. default-domain:: mongodb .. contents:: On this page