diff --git a/docs/command/atlas-accessLists-create.txt b/docs/command/atlas-accessLists-create.txt index f6bd387293..a9bb62b992 100644 --- a/docs/command/atlas-accessLists-create.txt +++ b/docs/command/atlas-accessLists-create.txt @@ -14,6 +14,11 @@ atlas accessLists create Create an IP access list entry for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project. The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries. diff --git a/docs/command/atlas-accessLists-delete.txt b/docs/command/atlas-accessLists-delete.txt index 9422e69964..26a09e1af8 100644 --- a/docs/command/atlas-accessLists-delete.txt +++ b/docs/command/atlas-accessLists-delete.txt @@ -14,6 +14,11 @@ atlas accessLists delete Remove the specified IP access list entry from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command, when run without the force option, prompts you to confirm the operation. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/docs/command/atlas-accessLists-describe.txt b/docs/command/atlas-accessLists-describe.txt index b759f71cff..2916020639 100644 --- a/docs/command/atlas-accessLists-describe.txt +++ b/docs/command/atlas-accessLists-describe.txt @@ -14,6 +14,11 @@ atlas accessLists describe Return the details for the specified IP access list entry. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-accessLists-list.txt b/docs/command/atlas-accessLists-list.txt index 7fc068133f..e2c003b9a6 100644 --- a/docs/command/atlas-accessLists-list.txt +++ b/docs/command/atlas-accessLists-list.txt @@ -14,6 +14,11 @@ atlas accessLists list Return all IP access list entries for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-accessLists.txt b/docs/command/atlas-accessLists.txt index 0c5ab90ee3..19b36580ea 100644 --- a/docs/command/atlas-accessLists.txt +++ b/docs/command/atlas-accessLists.txt @@ -14,6 +14,13 @@ atlas accessLists Manage the list of IP addresses that can access your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-accessLogs-list.txt b/docs/command/atlas-accessLogs-list.txt index c93e3257ba..eeefb6a3c2 100644 --- a/docs/command/atlas-accessLogs-list.txt +++ b/docs/command/atlas-accessLogs-list.txt @@ -14,6 +14,11 @@ atlas accessLogs list Retrieve the access logs of a cluster identified by the cluster's name or hostname. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role. Syntax diff --git a/docs/command/atlas-accessLogs.txt b/docs/command/atlas-accessLogs.txt index 6af9d05156..4e0a23cf30 100644 --- a/docs/command/atlas-accessLogs.txt +++ b/docs/command/atlas-accessLogs.txt @@ -14,6 +14,13 @@ atlas accessLogs Return the access logs for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-alerts-acknowledge.txt b/docs/command/atlas-alerts-acknowledge.txt index 45e26529e5..f66d042066 100644 --- a/docs/command/atlas-alerts-acknowledge.txt +++ b/docs/command/atlas-alerts-acknowledge.txt @@ -14,6 +14,11 @@ atlas alerts acknowledge Acknowledges the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-describe.txt b/docs/command/atlas-alerts-describe.txt index e67a940624..d95dbd7ee8 100644 --- a/docs/command/atlas-alerts-describe.txt +++ b/docs/command/atlas-alerts-describe.txt @@ -14,6 +14,11 @@ atlas alerts describe Return the details for the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-list.txt b/docs/command/atlas-alerts-list.txt index 1152d673ee..774d3faa92 100644 --- a/docs/command/atlas-alerts-list.txt +++ b/docs/command/atlas-alerts-list.txt @@ -14,6 +14,11 @@ atlas alerts list Return all alerts for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-create.txt b/docs/command/atlas-alerts-settings-create.txt index 87a1e7c5f3..ab19560667 100644 --- a/docs/command/atlas-alerts-settings-create.txt +++ b/docs/command/atlas-alerts-settings-create.txt @@ -14,6 +14,11 @@ atlas alerts settings create Create an alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings-delete.txt b/docs/command/atlas-alerts-settings-delete.txt index 8e22299a39..d33d5acb04 100644 --- a/docs/command/atlas-alerts-settings-delete.txt +++ b/docs/command/atlas-alerts-settings-delete.txt @@ -14,6 +14,11 @@ atlas alerts settings delete Remove the specified alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings-describe.txt b/docs/command/atlas-alerts-settings-describe.txt index 323cc68fb3..9125c794ab 100644 --- a/docs/command/atlas-alerts-settings-describe.txt +++ b/docs/command/atlas-alerts-settings-describe.txt @@ -14,6 +14,11 @@ atlas alerts settings describe Return the details for the specified alert settings for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-disable.txt b/docs/command/atlas-alerts-settings-disable.txt index c63bbd5355..360c0e8f32 100644 --- a/docs/command/atlas-alerts-settings-disable.txt +++ b/docs/command/atlas-alerts-settings-disable.txt @@ -14,6 +14,13 @@ atlas alerts settings disable Disables one alert configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-alerts-settings-enable.txt b/docs/command/atlas-alerts-settings-enable.txt index 9e54331291..81ceb0be67 100644 --- a/docs/command/atlas-alerts-settings-enable.txt +++ b/docs/command/atlas-alerts-settings-enable.txt @@ -14,6 +14,13 @@ atlas alerts settings enable Enables one alert configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-alerts-settings-fields-type.txt b/docs/command/atlas-alerts-settings-fields-type.txt index 891a1ed723..09252b546c 100644 --- a/docs/command/atlas-alerts-settings-fields-type.txt +++ b/docs/command/atlas-alerts-settings-fields-type.txt @@ -14,6 +14,11 @@ atlas alerts settings fields type Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-fields.txt b/docs/command/atlas-alerts-settings-fields.txt index 1f04c66bc9..2500a9b548 100644 --- a/docs/command/atlas-alerts-settings-fields.txt +++ b/docs/command/atlas-alerts-settings-fields.txt @@ -14,6 +14,13 @@ atlas alerts settings fields Manages alert configuration fields for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-alerts-settings-list.txt b/docs/command/atlas-alerts-settings-list.txt index 18033d8ba0..6b996a3957 100644 --- a/docs/command/atlas-alerts-settings-list.txt +++ b/docs/command/atlas-alerts-settings-list.txt @@ -14,6 +14,11 @@ atlas alerts settings list Returns all alert configurations for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-update.txt b/docs/command/atlas-alerts-settings-update.txt index a5355972e7..6a08acaeda 100644 --- a/docs/command/atlas-alerts-settings-update.txt +++ b/docs/command/atlas-alerts-settings-update.txt @@ -14,6 +14,11 @@ atlas alerts settings update Modify the details of the specified alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings.txt b/docs/command/atlas-alerts-settings.txt index 54f985bec4..64b230daf4 100644 --- a/docs/command/atlas-alerts-settings.txt +++ b/docs/command/atlas-alerts-settings.txt @@ -14,6 +14,11 @@ atlas alerts settings Manages alerts configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Use this command to list, create, edit, delete, enable and disable alert configurations. Options diff --git a/docs/command/atlas-alerts-unacknowledge.txt b/docs/command/atlas-alerts-unacknowledge.txt index 9d66e0b105..6c7aa958ed 100644 --- a/docs/command/atlas-alerts-unacknowledge.txt +++ b/docs/command/atlas-alerts-unacknowledge.txt @@ -14,6 +14,11 @@ atlas alerts unacknowledge Unacknowledge the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts.txt b/docs/command/atlas-alerts.txt index 75f0f7159e..bdd82ef0fd 100644 --- a/docs/command/atlas-alerts.txt +++ b/docs/command/atlas-alerts.txt @@ -14,6 +14,13 @@ atlas alerts Manage alerts for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 81024ee90d..ba8fbe5f34 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByClusterName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. +`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 1e90496484..85fec22650 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByHostname :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 6f605408a5..0ebddc346b 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -12,7 +12,12 @@ atlas api accessTracking :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. +`Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To view database access history, you must have either the Project Owner or Organization Owner role. @@ -51,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. .. toctree:: diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 88ed19505e..ce4f8469d7 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. +`Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 332e2955c5..d1812f59e2 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. +`Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index ce5faf039d..0bcfc10cd3 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. +`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 3ca531c7ee..55763db4a6 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +`Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can successfully call this endpoint with any assigned role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 2db1a88f15..e9ff08b2d2 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations for one project. +`Public Preview: please provide feedback `_: Returns all alert configurations for one project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 42d76f0e51..0b40174280 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. +`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 66a1d6e807..63e5f1c8b2 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations toggleAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. +`Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index bdc629b2b9..d290cde056 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +`Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index b05caf3c2e..094904ce1f 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +`Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,14 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback at `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback at `_: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback `_: Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index 3cc8bde25a..4bee277869 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,7 +12,12 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. +`Public Preview: please provide feedback `_: Confirms receipt of one existing alert. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 5ec5d9ca0b..ac0bf3d434 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -12,7 +12,12 @@ atlas api alerts getAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one alert. +`Public Preview: please provide feedback `_: Returns one alert. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 2bd4492ee2..deb7de30bf 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -12,7 +12,12 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alerts. +`Public Preview: please provide feedback `_: Returns all alerts. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 01a4bc1664..cca9aa4f4d 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,7 +12,12 @@ atlas api alerts listAlertsByAlertConfigurationId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +`Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index 717f4073a7..ac8b7cc15c 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -12,7 +12,12 @@ atlas api alerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +`Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,10 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback at `_: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback at `_: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback `_: Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback `_: Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback `_: Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. .. toctree:: diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 14e3eea21d..be212d4f97 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/createAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 0712474794..fb7b9477a8 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,7 +12,12 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index f42711c138..4f20178ee9 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,7 +12,12 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index bbc595e622..ed6205f9e1 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/deleteAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index da7ead331a..f70bf8d6a6 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,7 +12,12 @@ atlas api atlasSearch deleteAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index f958869631..fee20ac611 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,7 +12,12 @@ atlas api atlasSearch deleteAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 127c964826..6b1254ebe6 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,7 +12,12 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index b8b5127c20..6525be7883 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index a8319a44ac..721ec27bde 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index cf08903de4..912b8381a1 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 6259bb2e23..a13af36f02 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. +`Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index ea78c09365..0ce7091af3 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,7 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index c61864b720..f40f10ae70 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,7 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 00ec8117dc..6ab40e4498 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,7 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 09ba5a3a49..7f87829b3f 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/updateAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index ef0cb86e03..836c5b44e6 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,7 +12,12 @@ atlas api atlasSearch updateAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index b2b1555b7f..c3bccba1b9 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,7 +12,12 @@ atlas api atlasSearch updateAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 2990f223ed..84b342c703 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,7 +12,12 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index c550c6ad9c..8ce859650f 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -12,7 +12,12 @@ atlas api atlasSearch :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also returns and updates user-defined analyzers for the specified cluster. @@ -51,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`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. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. .. toctree:: diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index b6f8820919..3f43c39e0a 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,7 +12,12 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index d288654942..a8a8c01dbe 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,7 +12,12 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index b8f6b066a2..26b4564a7f 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -12,7 +12,14 @@ atlas api auditing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. +`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index 3cd6bdd1d4..926f2f45a4 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,7 +12,12 @@ atlas api awsClustersDns getAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index b898f6fa9b..d7ed862db7 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,7 +12,12 @@ atlas api awsClustersDns toggleAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 3542354c06..9dfe02b19e 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -12,7 +12,12 @@ atlas api awsClustersDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +`Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings. @@ -51,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 1fff972e20..9d1c95afa8 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups cancelBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. +`Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index 5d8c3c5d97..1c20672ecc 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups createBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +`Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 8a173c813e..b621bb9a0b 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups createBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one cluster from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 3091b09356..7bfb27a691 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,7 +12,12 @@ atlas api cloudBackups createExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +`Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 2b6bd50040..ed02cafbfe 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups createServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 07d353d504..a54441c65e 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,7 +12,12 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. +`Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 9bedcb8458..65e7e0d980 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,7 +12,12 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an Export Bucket. +`Public Preview: please provide feedback `_: Deletes an Export Bucket. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 86edc13776..256ea21964 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,7 +12,12 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified snapshot. +`Public Preview: please provide feedback `_: Removes the specified snapshot. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index ca09c87631..8b316e828d 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,7 +12,12 @@ atlas api cloudBackups deleteShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index a9ac3b55ef..72ff027b09 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,7 +12,12 @@ atlas api cloudBackups disableDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 5051db29ad..bb7c509dae 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 6f9c096eec..a3ade02a04 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 1b82900a34..8be902e9e8 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. +`Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index 7092059d16..6f1d82e306 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 60ac210376..9fd2c30d01 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. +`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index d9f9848af0..caa17ebde5 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. +`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 861ae06916..48bb89d7af 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getServerlessBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 156cc777ac..5a5d017b35 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 75f081acc7..a8ed172bc9 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,7 +12,12 @@ atlas api cloudBackups getShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 03f02fc153..138b9f1742 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listBackupExportJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index a8f8f7b84d..f09b3c3823 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index c9b19d88b2..d79b8f6264 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. +`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index df5371f1cf..5a1b8f4e00 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listReplicaSetBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 234f418be8..75ca5e0de1 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listServerlessBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index f080bfcbd6..3ac3dcc38a 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listServerlessBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 2b7a265142..82818e204f 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,7 +12,12 @@ atlas api cloudBackups listShardedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 30774ad320..7d6f14f256 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,7 +12,12 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. +`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index c54ca0836e..cfb47f9551 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,7 +12,12 @@ atlas api cloudBackups updateBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. +`Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 8b5ba1695d..c52b76132e 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,7 +12,12 @@ atlas api cloudBackups updateDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. +`Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 5e29072d06..a9c8413279 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,7 +12,12 @@ atlas api cloudBackups updateSnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The requesting API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 96e7207e66..0af954f8fc 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -12,7 +12,12 @@ atlas api cloudBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +`Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource applies only to clusters that use Cloud Backups. @@ -51,36 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`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. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback at `_: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback at `_: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback `_: Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback `_: Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index 90a7c18256..1d4e610796 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService createLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. +`Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 1d2da53ea2..0e7c37e2ce 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService createPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +`Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Please make sure to validate your migration before initiating it. diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index ed234c0da3..d5abf7aebe 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. +`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index 7ae7d4a934..ceac87edb9 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService deleteLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. +`Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index a604f6c929..29184178a9 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return details of one cluster migration job. +`Public Preview: please provide feedback `_: Return details of one cluster migration job. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 976cbbc480..75457b7ad9 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the status of one migration validation job. +`Public Preview: please provide feedback `_: Return the status of one migration validation job. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 163b02eea0..f69c4d97db 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService listSourceProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. +`Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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-Migration-Service/operation/listSourceProjects. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index a142e65cbd..a63fe9f1af 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService validateMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +`Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index b914deb87e..26af550033 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. +`Public Preview: please provide feedback `_: Manages the Cloud Migration Service. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA. @@ -51,14 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback at `_: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback at `_: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback at `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback `_: Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback `_: Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. .. toctree:: diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 37f8e67456..e0d268d6d2 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,7 +12,12 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index ec3e9d3ee1..996948a0ba 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,7 +12,12 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. +`Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 1b04845853..7b8442c2ac 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,7 +12,12 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index f7aa778add..a051c44f28 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,7 +12,12 @@ atlas api cloudProviderAccess getCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access role with the specified id and with access to the specified project. +`Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 0056553c3e..904e9da419 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,7 +12,12 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. +`Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index 36a7aa919d..6454c844c1 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -12,7 +12,14 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. -* :ref:`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. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. .. toctree:: diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index a7aeefcf15..501cb61eaa 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Ends a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index f6ce8a96bc..d7603fc289 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. +`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index f2d4076f6a..63e8d9075b 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +`Public Preview: please provide feedback `_: Starts a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index 2e11513cd9..c189351ae6 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -12,7 +12,14 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback at `_: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback `_: Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback `_: Starts a cluster outage simulation. .. toctree:: diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index 238bbf332c..d4db0fce67 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,7 +12,12 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. +`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 5ed626198c..113702e8b9 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -12,7 +12,12 @@ atlas api clusters createCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one cluster in the specified project. +`Public Preview: please provide feedback `_: Creates one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 86afd5ecd0..3aa744f336 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -12,7 +12,12 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index b736dab06b..58961961e8 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -12,7 +12,12 @@ atlas api clusters getCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 2870c387fa..fced8f154b 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,7 +12,12 @@ atlas api clusters getClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index 535fd79060..f6c7880bab 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -12,7 +12,12 @@ atlas api clusters getClusterStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of all changes that you made to the specified cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index abee87db9b..ba2b5110f1 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,7 +12,12 @@ atlas api clusters getSampleDatasetLoadStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. +`Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 6d15796ab0..272e16978b 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,7 +12,12 @@ atlas api clusters grantMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +`Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/grantMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index df8621c268..02ef17e1a1 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,7 +12,12 @@ atlas api clusters listCloudProviderRegions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of regions available for the specified cloud provider at the specified tier. +`Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index e51bfb729b..a61f2ef3a4 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -12,7 +12,12 @@ atlas api clusters listClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in the specific project to which you have access. +`Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index eb9ec215a5..5be6346b82 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,7 +12,12 @@ atlas api clusters listClustersForAllProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have access. +`Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 5d69af2b77..684cf0fe79 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,7 +12,12 @@ atlas api clusters loadSampleDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. +`Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 9ffd7785c1..df030e9dd7 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,7 +12,12 @@ atlas api clusters pinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +`Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 7b9fd45270..80d1b4b781 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,7 +12,12 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes a previously granted MongoDB employee cluster access. +`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/revokeMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 1824968938..671033d5b8 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -12,7 +12,12 @@ atlas api clusters testFailover :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. +`Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 89b793d1ae..1423fa6145 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,7 +12,12 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). +`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This feature is not available for clusters on rapid release. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 0cf0556dbd..2513a740dd 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -12,7 +12,12 @@ atlas api clusters updateCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index e1d76bd206..52458c9391 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,7 +12,12 @@ atlas api clusters updateClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index 804ed158a2..3135b27d9c 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,7 +12,12 @@ atlas api clusters upgradeSharedCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +`Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index 3a515820fe..fe4ff5137f 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -12,7 +12,12 @@ atlas api clusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. -* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback at `_: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback at `_: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`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. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback at `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - `Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `Public Preview: please provide feedback at `_: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`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. +* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. +* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback `_: Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback `_: Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - `Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - `Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - `Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - `Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - `Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 847ae8b9c5..01e6a8aa9f 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getCollStatsLatencyNamespaceClusterMeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index b3ee5fbe45..5390d030d7 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,7 +12,12 @@ 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 `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 2eea1dc05b..22a88d3d85 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getCollStatsLatencyNamespaceMetrics. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 87b67830c6..e5de6a7856 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getCollStatsLatencyNamespacesForCluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index c6bd756c49..961c57f3d2 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getCollStatsLatencyNamespacesForHost. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 04524f4453..942648ee68 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getPinnedNamespaces :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getPinnedNamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index cfb1b352bc..65542d0ff5 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics pinNamespacesPatch :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/pinNamespacesPatch. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 6bfd555efc..3da6a1d762 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics pinNamespacesPut :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 4abbaaaca2..35988e455c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,7 +12,12 @@ 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 `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 5ec03b981d..742e9e2497 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +`Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also returns collection level latency metric data. @@ -51,15 +56,15 @@ Inherited Options 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. -* :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. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback `_: 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 `_: 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 `_: 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 `_: 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 `_: 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 `_: 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 `_: 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 `_: 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 `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. .. toctree:: diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index e9647ea3dd..04532b759f 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom role in the specified project. +`Public Preview: please provide feedback `_: Creates one custom role in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index bd77a4e37a..7ca62893aa 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one custom role from the specified project. +`Public Preview: please provide feedback `_: Removes one custom role from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index cccd26e63f..c6d675d585 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one custom role for the specified project. +`Public Preview: please provide feedback `_: Returns one custom role for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 911ab13a1e..10688a8ab9 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. +`Public Preview: please provide feedback `_: Returns all custom roles for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index 3b643f8ea0..e567208efc 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +`Public Preview: please provide feedback `_: Updates one custom role in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index bb0a0b3c7b..1e366e97b9 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback `_: Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback `_: Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback `_: Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback `_: Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback `_: Updates one custom role in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index 0939a336dd..8c994d59c8 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api dataFederation createDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +`Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index b4e6d1b036..28c469ee62 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,7 +12,12 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. +`Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index 8b4107f747..f30f235caf 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,7 +12,12 @@ atlas api dataFederation createOneDataFederationQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. +`Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 3b0da301ab..d5ba23fb36 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index be5b337232..9d2e90efc7 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,7 +12,12 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. +`Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 0e460664b8..149fc7d47d 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,7 +12,12 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. +`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 698033d4a1..44ec3de6ae 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,7 +12,12 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. +`Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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". diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index 671b3be29e..8ffb85b0ad 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api dataFederation getDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +`Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index edae70a753..5c8c20149e 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,7 +12,12 @@ atlas api dataFederation getFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 52cc26b021..fe694fd449 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,7 +12,12 @@ atlas api dataFederation listDataFederationPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 9224915bcf..cd15520fc3 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,7 +12,12 @@ atlas api dataFederation listFederatedDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. +`Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 22b77adc8f..d4e0f217ae 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,7 +12,12 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one query limit for the specified federated database instance in the specified project. +`Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index f85a5b6548..b215dfb5d8 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,7 +12,12 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in the specified project. +`Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 7d786b4a5b..baa2fc5663 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,7 +12,12 @@ atlas api dataFederation updateFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +`Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index ba6872e585..9c3ef77362 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -12,7 +12,12 @@ atlas api dataFederation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource requires your project ID. Changes to federated database instance configurations can affect costs. @@ -51,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. -* :ref:`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. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. -* :ref:`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. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. -* :ref:`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. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. -* :ref:`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. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt index 59b73da42e..156fa43b79 100644 --- a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines createPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/createPipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt index ccb06b4131..5857f87f6c 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines deletePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/deletePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 0cbd3549be..cddd27953c 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines deletePipelineRunDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. +`Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/deletePipelineRunDataset. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt index f37335bbf5..0ecbbef181 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines getPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index fc55f00eef..38b9d6a858 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines getPipelineRun :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 50ba5ae7b9..0891dd888b 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines listPipelineRuns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. +`Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 697b593217..a7cfa52f77 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines listPipelineSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +`Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index daec0a0d77..d3639acad8 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines listPipelineSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +`Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index 5c71178c35..8eb6937193 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines listPipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. +`Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index c3df9dc7cc..a8b9c41b3f 100644 --- a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines pausePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index 3cd8bb0d77..104c23717b 100644 --- a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines resumePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index c0f65e0055..80c7152fa5 100644 --- a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines triggerSnapshotIngestion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +`Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/triggerSnapshotIngestion. diff --git a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt index b7ac25dcd7..5519bc5b23 100644 --- a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines updatePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/updatePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines.txt b/docs/command/atlas-api-dataLakePipelines.txt index 46f5e1e586..1c79ff1023 100644 --- a/docs/command/atlas-api-dataLakePipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines.txt @@ -12,7 +12,14 @@ atlas api dataLakePipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +`Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,19 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. .. toctree:: diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index a6bd2acc2a..8aa2d47ce6 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,7 +12,12 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one database user in the specified project. +`Public Preview: please provide feedback `_: Creates one database user in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index c4d2a4d426..ef6511c3ae 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,7 +12,12 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one database user from the specified project. +`Public Preview: please provide feedback `_: Removes one database user from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index b7259ada47..031d4bb007 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,7 +12,12 @@ atlas api databaseUsers getDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. +`Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index ac17229b97..9085da2957 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,7 +12,12 @@ atlas api databaseUsers listDatabaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. +`Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 428cb4e2e4..06b5df3c5c 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,7 +12,12 @@ atlas api databaseUsers updateDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +`Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 946715b80a..8b6f4986b2 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -12,7 +12,14 @@ atlas api databaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback at `_: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback at `_: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback `_: Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback `_: Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. .. toctree:: diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 42b092a3ec..96c11f60ff 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index e087e0a706..e39d2e6563 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 94f3ca9398..99842e0cb8 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 15160f38b6..144fd4f259 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index a9735658f4..f6e8627005 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 97ad183d60..b23f0f2e45 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index de3690c02f..13e519603d 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +`Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud encrypts all storage whether or not you use your own key management. @@ -51,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`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. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `Public Preview: please provide feedback at `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `Public Preview: please provide feedback at `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`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. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. .. toctree:: diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index 31319e99bf..2e2390af61 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -12,7 +12,12 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified organization. +`Public Preview: please provide feedback `_: Returns one event for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 952f86ec83..6651549648 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -12,7 +12,12 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified project. +`Public Preview: please provide feedback `_: Returns one event for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index 77cad6d06a..595372c8ef 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -12,7 +12,12 @@ atlas api events listEventTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all event types, along with a description and additional metadata about each event. +`Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index 1ea011cfaf..5c44c570b1 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -12,7 +12,12 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified organization. +`Public Preview: please provide feedback `_: Returns all events for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index 7e26dc8067..df9efac288 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -12,7 +12,12 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified project. +`Public Preview: please provide feedback `_: Returns all events for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index d7ffbcbbe5..20eb7fa2f8 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -12,7 +12,12 @@ atlas api events :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns events. +`Public Preview: please provide feedback `_: Returns events. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback at `_: Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - `Public Preview: please provide feedback at `_: Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback at `_: Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index f80b82769e..d96edc07e8 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. +`Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 17d155ee5d..0413ffe3bb 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication createRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 419f1b582b..bae51741d2 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication deleteFederationApp :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +`Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner 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. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index a924fe337a..03f1637fba 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index a9bd457a62..758e600cb8 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication deleteRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. +`Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index f6db8a14de..346f82f711 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication getConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. +`Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index f8e800a1d2..b864992b3b 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication getFederationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. +`Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index a214d1f3dc..3a45f7c8f7 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication getIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. +`Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 2cbfa3652d..b74f7fbc14 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication getIdentityProviderMetadata :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 52062478b1..5d3a151ed3 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication getRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index 0d56e97adf..5bf8868ee5 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. +`Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 02286287e6..31f1d08cf9 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication listIdentityProviders :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. +`Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 1c41a8901b..1bf6760069 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication listRoleMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 2afb49091b..f172ec3d7a 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 27e0bb7063..c308a52ec7 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. +`Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 4121f24964..de8bcefac2 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index a51f6fa936..d1f15920fa 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index e301dbe3c4..03877d83aa 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,7 +12,12 @@ atlas api federatedAuthentication updateRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index 7c46230652..fe3858d011 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -12,7 +12,14 @@ atlas api federatedAuthentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. .. toctree:: diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index 8942d71b73..9ad973efab 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,7 +12,12 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 6cae34458c..14e91c7244 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,7 +12,12 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 0e85995b02..5a89576ab3 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,7 +12,12 @@ atlas api flexClusters getFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 781344a381..7d459df5ac 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,7 +12,12 @@ atlas api flexClusters listFlexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. +`Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 7f75897962..fa746bd445 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,7 +12,12 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 6598098c97..06871287af 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,7 +12,12 @@ atlas api flexClusters upgradeFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +`Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 59baa45aeb..26006f16d1 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -12,7 +12,14 @@ atlas api flexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes flex clusters. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 93c2f9d6a6..cc7aa3f0d2 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 749cb5a137..5976a2d64d 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index fed554366b..59f2179796 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,7 +12,12 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 6b23cc00ae..60d27b2e76 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -12,7 +12,14 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. .. toctree:: diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 1633aff61b..2ba61c8909 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,7 +12,12 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. +`Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index 99113cd7e1..89c4a960be 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,7 +12,12 @@ atlas api flexSnapshots getFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index e8a3988378..fea9a62048 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,7 +12,12 @@ atlas api flexSnapshots listFlexBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 3a42b48691..68eed67439 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -12,7 +12,14 @@ atlas api flexSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. .. toctree:: diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index a508c4b35b..dd48c0a2db 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,7 +12,12 @@ atlas api globalClusters createCustomZoneMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. +`Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index e1be2d8115..836a0e506c 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,7 +12,12 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 5bb835ef0a..e84ef6d3c7 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,7 +12,12 @@ atlas api globalClusters deleteAllCustomZoneMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. +`Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index ab23a4c2b4..62652b0005 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,7 +12,12 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index e1456d8f03..216ecbbd1b 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,7 +12,12 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index d80a740f31..61febfcba7 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -12,7 +12,12 @@ atlas api globalClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +`Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection. MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is city, the compound shard key is location, city. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the Global Cluster Configuration pane when you create or modify your Global Cluster. @@ -52,11 +57,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. .. toctree:: diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 59ca1c05e2..5143f92118 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,7 +12,12 @@ atlas api invoices createCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. +`Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + A token is returned that can be used to poll the status of the query and eventually retrieve the results. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 00c503d530..9faae27c4f 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,7 +12,12 @@ atlas api invoices downloadInvoiceCsv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 1278f60aff..52cdf5b434 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,7 +12,12 @@ atlas api invoices getCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +`Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index b09dbe63f6..1fc096b9d8 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -12,7 +12,12 @@ atlas api invoices getInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index df897cdb9a..39093e0cb2 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -12,7 +12,12 @@ atlas api invoices listInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index 9e67c8c068..5554d0cf0a 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,7 +12,12 @@ atlas api invoices listPendingInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +`Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization 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. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index df0acf3253..825e02001c 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,7 +12,12 @@ atlas api invoices queryLineItemsFromSingleInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +`Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + A unique 24-hexadecimal digit string identifies the invoice. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 9187866ae9..4918bd1119 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -12,7 +12,14 @@ atlas api invoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns invoices. +`Public Preview: please provide feedback `_: Returns invoices. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,13 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. -* :ref:`atlas-api-invoices-getInvoice` - `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +* :ref:`atlas-api-invoices-getInvoice` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. .. toctree:: diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 36cdcbeb40..5235e6253e 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration deleteLdapConfiguration :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 801400baa4..dadc5f730e 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index d23cddf840..296155dbe8 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration getLdapConfigurationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one request to verify one LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index c4a0c9b024..ed91005234 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index df010c815e..8e18612f05 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index d8232a70cf..c56abd5261 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. +`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`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. -* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - `Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. -* :ref:`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. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `Public Preview: please provide feedback `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - `Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 9dfe382cfe..b031878d07 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api legacyBackup createLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. +`Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 2531662914..6c35abdb0f 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,7 +12,12 @@ atlas api legacyBackup deleteLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index 5d3cece2f4..ead0159c52 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,7 +12,12 @@ atlas api legacyBackup getLegacyBackupCheckpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index f3916a4fdf..07b2ef6ff9 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api legacyBackup getLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index bc9ba95dee..50ee7fc73e 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,7 +12,12 @@ atlas api legacyBackup getLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index fdb95a4b85..71b67a5f32 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,7 +12,12 @@ atlas api legacyBackup getLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index e217d3cc49..1462154811 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,7 +12,12 @@ atlas api legacyBackup listLegacyBackupCheckpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index d029703fc4..6aa0034030 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,7 +12,12 @@ atlas api legacyBackup listLegacyBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index 95c69bd3f9..62e6f96010 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,7 +12,12 @@ atlas api legacyBackup listLegacySnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 41032f4405..98f6d6b207 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,7 +12,12 @@ atlas api legacyBackup updateLegacySnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index d176377f47..02367dead1 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,7 +12,12 @@ atlas api legacyBackup updateLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index 51c7621381..305203aafc 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -12,7 +12,14 @@ atlas api legacyBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,17 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`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. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index 897e67be9e..5cf1fe2e1f 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 0c0862c49f..6405339c99 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 202b6e38be..4d21ca22f2 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 8332c83056..8849ffdc79 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index 0d58a227cb..24b7e7e476 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index f9afbf26df..85b2397da2 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. +`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index ae5212353d..938d872075 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers addOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 26ee0230fd..22a58471c2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers addProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index b5ce6cfeea..1c050c2376 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 8787e6c1e3..f217ce6ef2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index b6a3d167b9..9d87235354 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers createOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. +`Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index 3b69db07ee..72c2f8a342 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. +`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 3f828cae34..2756bd8a5b 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers getOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index c2de3249c4..6b4c1d4097 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers getProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index a0709c0938..0d02445785 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers getUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index cbbf435e72..c3a7d54520 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers getUserByUsername :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. +`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index ea1b75e333..286270a8a1 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers listOrganizationUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index b26c54709d..ea9acd0aa0 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers listProjectUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 65538702a3..d46df62064 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers listTeamUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 362f9eec2f..7929448f9f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers removeOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index e83dad6eb7..73f7455a2c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 235ef957e7..6249b60158 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers removeProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index 5bef83a8f2..5f04240f28 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index cb1d8ca618..d860ff389d 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index 748cfd7566..83fc8ba2fa 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 1d60ef212d..55ecbf811e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -12,7 +12,14 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. +`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,25 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. -* :ref:`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. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`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. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. .. toctree:: diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index 30ed532e5c..ef0a8dd075 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getAtlasProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index ebf8ade1e6..fdb236d5e4 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index cc743bc88e..18efcdcc86 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getDatabaseMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 84a65f048f..549a2a6d07 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt index a0d76eeb1f..594a5d2fb9 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getHostLogs :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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". diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 2769fe8f73..2930f78e9f 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index 460216cde9..04b6e080aa 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +`Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index c9c9e13e3b..33ea96c5b7 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +`Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 8c4de1d535..379ed66d1e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. +`Public Preview: please provide feedback `_: Returns details of all processes for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index 86e82bb4c4..8102e10cae 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 5d14b35be7..db5a49ffd3 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns measurement details for one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 3522f4d942..ea7013c9f2 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listDiskPartitions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of disks or partitions for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index e0d72757bc..6041dcd328 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +`Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/listIndexMetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index 0973a15417..e9571f5eea 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listMetricTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search metric types available for one process in the specified project. +`Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 6a57195777..9cbfd6e61d 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -12,7 +12,14 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. +`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback at `_: Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`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. -* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - `Public Preview: please provide feedback at `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `Public Preview: please provide feedback at `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - `Public Preview: please provide feedback at `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - `Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `Public Preview: please provide feedback at `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `Public Preview: please provide feedback at `_: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `Public Preview: please provide feedback `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - `Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - `Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - `Public Preview: please provide feedback `_: Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 30cc694330..6f9f78f7cb 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api networkPeering createPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. +`Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 807f2a1535..7567cd6053 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,7 +12,12 @@ atlas api networkPeering createPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. +`Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index e6b12b1e60..57ee871203 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,7 +12,12 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. +`Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index 1a78a44fd2..7cc9942455 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,7 +12,12 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. +`Public Preview: please provide feedback `_: Removes one network peering container in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index e05189cf5f..c4fc519f64 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -12,7 +12,12 @@ atlas api networkPeering disablePeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. +`Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index e97cd1f5d8..34d0e1f995 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api networkPeering getPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index b0cb542866..be545b86d5 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,7 +12,12 @@ atlas api networkPeering getPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. +`Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index 89df6dda6e..1ef7e84d0f 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,7 +12,12 @@ atlas api networkPeering listPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. +`Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 9c1493220e..b5468370c6 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,7 +12,12 @@ atlas api networkPeering listPeeringContainerByCloudProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 6ba5038007..286413665d 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,7 +12,12 @@ atlas api networkPeering listPeeringContainers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. +`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 52d2e84d3e..6d79651bb8 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,7 +12,12 @@ atlas api networkPeering updatePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 2dba9e2eb6..2be16fe42d 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,7 +12,12 @@ atlas api networkPeering updatePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the network details and labels of one specified network peering container in the specified project. +`Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index ade58baa6d..7bafed75d3 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,7 +12,12 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +`Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index 2654e29ed4..b7878bb5b8 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -12,7 +12,12 @@ atlas api networkPeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block. @@ -51,19 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. -* :ref:`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. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - `Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. -* :ref:`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. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback `_: Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. .. toctree:: diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index c960cb79da..ecb1f51743 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,7 +12,12 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one online archive. +`Public Preview: please provide feedback `_: Creates one online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 49ba3d9665..a7d65632ae 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,7 +12,12 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one online archive. +`Public Preview: please provide feedback `_: Removes one online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 90a17303a4..e957e3095a 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,7 +12,12 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. +`Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the 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". diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index c79acac08b..f3f7c23d22 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,7 +12,12 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one online archive for one cluster. +`Public Preview: please provide feedback `_: Returns one online archive for one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index c8f67f6107..99dbcaf7b6 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,7 +12,12 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all online archives. +`Public Preview: please provide feedback `_: Returns details of all online archives. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 207d4d5b34..6751ffe7f0 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,7 +12,12 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +`Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index 2898a1397a..c739fb421f 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -12,7 +12,14 @@ atlas api onlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback at `_: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback at `_: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback at `_: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback at `_: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback `_: Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback `_: Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback `_: Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback `_: Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 2609e76e8b..e1c0df3930 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -12,7 +12,12 @@ 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 Service Account's or API Key's organization. +`Public Preview: please provide feedback `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner 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. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 32c2ce9f57..ed8e5b9298 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,7 +12,12 @@ atlas api organizations createOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 52c8ed35eb..589a24f72b 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -12,7 +12,12 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one specified organization. +`Public Preview: please provide feedback `_: Removes one specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud imposes the following limits on this resource: diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 47adb79a58..7a903076d1 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,7 +12,12 @@ atlas api organizations deleteOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 3ea34a8543..0518154ce7 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -12,7 +12,12 @@ atlas api organizations getOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization to which the requesting Service Account or API Key has access. +`Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 3c2ff14113..2ab06106c8 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,7 +12,12 @@ atlas api organizations getOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 46fba4d63b..5506cc7dbf 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,7 +12,12 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. +`Public Preview: please provide feedback `_: Returns details about the specified organization's settings. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 3266b49da8..fa0527d55e 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,7 +12,12 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index bdb8f5a618..185a627b00 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,7 +12,12 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. +`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 262cd9cd1b..a8ba02280a 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -12,7 +12,12 @@ atlas api organizations listOrganizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organizations to which the requesting Service Account or API Key has access. +`Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index 4870d1834a..c70cfe7d5e 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization. +`Public Preview: please provide feedback `_: Updates one organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 91a30220d4..283d76c759 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationInvitation :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 4ffe789397..0476cc3f24 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 93b98fd20b..fa3bf2577e 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To 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. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index b89db7c3c4..d11e5e6243 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the organization's settings. +`Public Preview: please provide feedback `_: Updates the organization's settings. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 8d12bcb694..426d78e481 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -12,7 +12,14 @@ atlas api organizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,21 +56,21 @@ 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 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 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 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. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback at `_: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback `_: 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 `_: Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback `_: Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback `_: 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 `_: Returns one organization to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback `_: Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback `_: Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback `_: 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 `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback `_: Updates the organization's settings. .. toctree:: diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index 52332e9899..806b6cd349 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor disableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +`Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 07ab856a53..fe4f2f1468 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor enableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +`Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 92ea589e22..0401233ff1 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getManagedSlowMs. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 1f3daa5834..243973bcd2 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 4eb1b3bc97..e28c193331 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index a12c6ff813..b5c6f0423b 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listDropIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index e091e4766d..8ae098b1e4 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. +`Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index bd64ac5ac1..266699b2a3 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listSlowQueries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +`Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index ce048515ca..e1a6dcfb63 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listSlowQueryNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +`Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 80509f8bbf..2fb009914c 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 2f4ea1ca8a..d52caa0ce1 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 64c082a920..93dc2d2a30 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. +`Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. @@ -51,17 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. .. toctree:: diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 8441fe7a8a..ec1fc35374 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices createPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. +`Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index d7d5d9f78c..e13a2cc72d 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices createPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. +`Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 64fcf2d840..c9e842afba 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices deletePrivateEndpoint :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 64331230ac..f92f9e9ae8 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. +`Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index bb41a0eefa..86ef631422 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. +`Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index ed7a82bc0f..3caa103bf8 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices getPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 566d1ecc63..8a0aeea8a8 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +`Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index 8c975d6d11..18c0462e4b 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices listPrivateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index 724c824fbc..2e9131b360 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,7 +12,12 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 89bf2afea8..12389df643 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -12,7 +12,14 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,15 +56,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. -* :ref:`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. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - `Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. -* :ref:`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. -* :ref:`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. -* :ref:`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. -* :ref:`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. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - `Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. .. toctree:: diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 8761bd5fce..fb0bdcdce4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys addProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 5d72a42b02..cc8d69078f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one API key for the specified organization. +`Public Preview: please provide feedback `_: Creates one API key for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 02407bb1d8..b8c16ecac4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys createApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. +`Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 9a11a3153e..df00f90027 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys createProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 5caa4fd311..56718bd6b1 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. +`Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 02eda0c405..24a229d11f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index d99a3fa352..a2b431bf64 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization API key. +`Public Preview: please provide feedback `_: Returns one organization API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 1b06bf06e2..60b286c6d4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys getApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. +`Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 9bff1a8a70..c58ffe5a73 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index e22b699d52..e719999329 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. +`Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index bbfa913277..bad6218592 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys listProjectApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. +`Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index 4aedffa8b5..3a0e0f06e3 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. +`Public Preview: please provide feedback `_: Removes one organization API key from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 054d38cd6c..693ddcce4e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. +`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index ae795624f8..ab6b34af5c 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys updateApiKeyRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +`Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 4fccf957cb..e6e1889c48 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project. @@ -51,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback at `_: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback at `_: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback `_: Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback `_: Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. .. toctree:: diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index b270e58c12..14873209dc 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList createProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. +`Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 875305fab2..57170c7f38 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList deleteProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index d4ec658254..b8f758cbad 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList getProjectIpAccessListStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. +`Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 0a14f691da..6f171aeccc 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList getProjectIpList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index 38898d5ab9..b607f41776 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList listProjectIpAccessLists :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +`Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 7ed6dd81bb..3dbbea9510 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. .. toctree:: diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index ef1d68283a..a9d8f95c85 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -12,7 +12,12 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index 6d8c30392b..6927e64f15 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -12,7 +12,12 @@ atlas api projects createProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one project. +`Public Preview: please provide feedback `_: Creates one project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index a8daf5a7d1..5ea321eeba 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -12,7 +12,12 @@ atlas api projects createProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 0fa7d480b1..b39c5240e7 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -12,7 +12,12 @@ atlas api projects deleteProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project. +`Public Preview: please provide feedback `_: Removes the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 02f6a52d1a..7224c04b8c 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,7 +12,12 @@ atlas api projects deleteProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index 1b4a5a2e2f..f1be0de7d3 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,7 +12,12 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project limit. +`Public Preview: please provide feedback `_: Removes the specified project limit. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index a89f72465e..bd92235118 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -12,7 +12,12 @@ atlas api projects getProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project. +`Public Preview: please provide feedback `_: Returns details about the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index 43952f13bd..ff0befed2d 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -12,7 +12,12 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the project identified by its name. +`Public Preview: please provide feedback `_: Returns details about the project identified by its name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index e6cbc1f9fc..bd40a32e04 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -12,7 +12,12 @@ atlas api projects getProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index 80b01df2e0..c257541757 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -12,7 +12,12 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. +`Public Preview: please provide feedback `_: Returns the specified limit for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index bb7998cc69..ecdbb309c6 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,7 +12,12 @@ atlas api projects getProjectLtsVersions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +`Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getProjectLtsVersions. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index b95bd81426..4e965de496 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -12,7 +12,12 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project's settings. +`Public Preview: please provide feedback `_: Returns details about the specified project's settings. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 0178ba2800..1e0ba19ded 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -12,7 +12,12 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index 5704d8f066..6dbec8413e 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -12,7 +12,12 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all the limits for the specified project. +`Public Preview: please provide feedback `_: Returns all the limits for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index f0b9dfc43e..f37dd3c1f7 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -12,7 +12,12 @@ atlas api projects listProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all projects. +`Public Preview: please provide feedback `_: Returns details about all projects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 65963ac346..305d0a15bc 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,7 +12,12 @@ atlas api projects migrateProjectToAnotherOrg :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. +`Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 4289f7ed02..57fd4d2a4c 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,7 +12,12 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all IP addresses for this project. +`Public Preview: please provide feedback `_: Returns all IP addresses for this project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index 98940b852c..c7329dcdf7 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -12,7 +12,12 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Sets the specified project limit. +`Public Preview: please provide feedback `_: Sets the specified project limit. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index e79239a862..6d7f494758 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -12,7 +12,12 @@ atlas api projects updateProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +`Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 07b65cdb3b..0331b8f602 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 5cdf059b79..fbb0a468ef 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index 0fc15c669f..775488b1dc 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To 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. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index bdb612e5f5..294ca53b21 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings of the specified project. +`Public Preview: please provide feedback `_: Updates the settings of the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index e3b605e506..b54857656f 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -12,7 +12,14 @@ atlas api projects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,29 +56,29 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback at `_: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback at `_: Removes the specified project. -* :ref:`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. -* :ref:`atlas-api-projects-deleteProjectLimit` - `Public Preview: please provide feedback at `_: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback at `_: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback at `_: Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback at `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - `Public Preview: please provide feedback at `_: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback at `_: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback at `_: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback at `_: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback at `_: Sets the specified project limit. -* :ref:`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. -* :ref:`atlas-api-projects-updateProjectInvitation` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback at `_: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback `_: Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback `_: Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - `Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - `Public Preview: please provide feedback `_: Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback `_: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback `_: Returns details about the project identified by its name. +* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback `_: Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - `Public Preview: please provide feedback `_: Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback `_: Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback `_: Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback `_: Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback `_: Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - `Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback `_: Updates the settings of the specified project. .. toctree:: diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index 8fe0258bda..4df2c65d42 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index c5c7ed4125..7dd590b44d 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +`Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index ae87cf590e..6be515c9a1 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Fetches the current project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index c8efc8dc23..a81705f599 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 030946a346..4a27e38c73 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +`Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Atlas exports logs every 5 minutes. @@ -51,10 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. .. toctree:: diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 93b63c0f25..901de65a0c 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies createAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 2b7ce7f30a..dbdb6d9935 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies deleteAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index 2f057a942b..906be30f6d 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. +`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 01322ea5a1..349824f9c3 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 6821b00510..3d71862c56 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. +`Public Preview: please provide feedback `_: Return all non-compliant resources for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant. diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index f67689b495..2f95973b68 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies updateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index c9530573ad..4a846de4ff 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index bc963944e2..02cc4408d0 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -12,7 +12,14 @@ atlas api resourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. +`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,13 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback `_: Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. .. toctree:: diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 14aed7692f..e5783b89c0 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,7 +12,12 @@ atlas api rollingIndex createRollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +`Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 44bd0f715e..1a581a5ba5 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -12,7 +12,12 @@ atlas api rollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. +`Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. @@ -51,7 +56,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. .. toctree:: diff --git a/docs/command/atlas-api-root-getSystemStatus.txt b/docs/command/atlas-api-root-getSystemStatus.txt index a5218d9b7c..633e7bea22 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -12,7 +12,12 @@ atlas api root getSystemStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. +`Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index bd896231c0..f328e8162a 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,7 +12,12 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +`Public Preview: please provide feedback `_: Returns all control plane IP addresses. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 123c460b04..4c6c5b27f0 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -12,7 +12,12 @@ atlas api root :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +`Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This starts the MongoDB Cloud API. @@ -51,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback `_: Returns all control plane IP addresses. .. toctree:: diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 1a552bfdf7..294259f98d 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,7 +12,12 @@ atlas api serverlessInstances createServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +`Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 4c9767ce27..9a5ebfa355 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,7 +12,12 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 098240884d..7b225f3693 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,7 +12,12 @@ atlas api serverlessInstances getServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. +`Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index f256bda253..a35b52ba7e 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,7 +12,12 @@ atlas api serverlessInstances listServerlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. +`Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index e72c4a3e9c..6669e0c417 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,7 +12,12 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index eaacf209fe..0acc578a01 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -12,7 +12,14 @@ atlas api serverlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index b9b6755bc7..c55c90492f 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index 99030f9bdf..68bb9d0e01 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. +`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index eccb4ff8da..bbcf7477d8 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 4ec14f63dc..174ad3357a 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. +`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 2966872870..5ba1561184 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 1565530950..d4eeba2c2e 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To learn more, see the Atlas Administration API tab on the following tutorial. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. .. toctree:: diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index cece36a99d..1f0e5aedbd 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. +`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index f254e194ba..bfceb7941e 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 6ce61b547d..646c014a26 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. +`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 1fdf716ecf..be806d1950 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index b8996b8c52..f6db7b32f7 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 7098195318..2201aafa19 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 931f838a71..31cf2fd0a1 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 29978dcf8d..c081cb8efb 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. +`Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 815e3efe32..32234dad7f 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index b666cf752b..ece1ea74b1 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index 5ad8eb7abf..640f1ede7a 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account. +`Public Preview: please provide feedback `_: Deletes the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index dabef83ad8..086992af84 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 7976073f39..f677b04750 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index dd9c5c299f..3e43642cb6 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index bfbc418d79..426b64328c 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified Service Account. +`Public Preview: please provide feedback `_: Returns the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index ca8cadaa07..acfd085808 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts listProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the project. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 2f321afce3..f1cb787d9d 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Project. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 123b93d6d8..12a422d1f5 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts listServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 373a785363..77ba465a41 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts listServiceAccountProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all projects the specified Service Account is a part of. +`Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 32c31fcaf1..26a540dff6 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 24e20a98ae..1dbdd27072 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 7dfacf97bb..0e62de1423 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 3d584d002a..096b1c2053 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -12,7 +12,12 @@ atlas api serviceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. +`Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. @@ -51,28 +56,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback at `_: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `Public Preview: please provide feedback at `_: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback `_: Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback `_: Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index 2eabdd80a3..6862471965 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 2a3f7bac9d..8098fc99e0 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,7 +12,12 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 2994b2408a..8e87872150 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,7 +12,12 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 2b22084999..415f404b52 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,7 +12,14 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index dbb1c16b3e..7bb3e380f7 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,7 +12,12 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index 1784e8cfdb..fc3a0159c8 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,7 +12,12 @@ atlas api sharedTierSnapshots getSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index 243bccbdc6..390bbf1671 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,7 +12,12 @@ atlas api sharedTierSnapshots listSharedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +`Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 310091f249..ca50d27fac 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -12,7 +12,14 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. .. toctree:: diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index d7964756fc..6d39156ab8 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/acceptVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index c74964a38a..b2571549c5 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,7 +12,12 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. +`Public Preview: please provide feedback `_: Creates one Private Link in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 0fd271440c..d9bbed8615 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -12,7 +12,12 @@ atlas api streams createStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. +`Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index c591af289c..59bb82efed 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -12,7 +12,12 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index 6fe3a7aa2a..0e63dc307c 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,7 +12,12 @@ atlas api streams createStreamInstanceWithSampleConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 60fdb53c3e..a280e38946 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 4452bb5b35..823c771942 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,7 +12,12 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. +`Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 4a0a6ec01a..122567f201 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,7 +12,12 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. +`Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 61c50d9fa0..bef646f2fd 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,7 +12,12 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. +`Public Preview: please provide feedback `_: Delete one stream instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index f275daa181..9bb76318bf 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 85eb58ae4a..2a5ecd75f5 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/deleteVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index d41d62b109..56839a16e3 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,7 +12,12 @@ atlas api streams downloadStreamTenantAuditLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +`Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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". diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index 7ffce7cadc..44a7c3b2be 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -12,7 +12,12 @@ atlas api streams getAccountDetails :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. +`Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getAccountDetails. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index 026edf54b2..a2f7912527 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,7 +12,12 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getActiveVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 5003052686..8d596d6e57 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,7 +12,12 @@ atlas api streams getPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. +`Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index e9f6bca730..30c844fef7 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -12,7 +12,12 @@ atlas api streams getStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. +`Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index f45429b7a8..d4fda560a3 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -12,7 +12,12 @@ atlas api streams getStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 52f5fac9ee..e942f22fd2 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index 6e11224132..8253cf824b 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,7 +12,12 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/getVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 19ae055928..2e4052642b 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,7 +12,12 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. +`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 2c70fffc14..906035e3df 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -12,7 +12,12 @@ atlas api streams listStreamConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. +`Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 7fb6bf3c1e..6ffd4b530f 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -12,7 +12,12 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. +`Public Preview: please provide feedback `_: Returns all stream instances for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/listStreamInstances. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index 7a066cea53..048a724032 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -12,7 +12,12 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. +`Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index 78dff3fa2c..60e61de362 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams modifyStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index f75a4a3025..6add535e4f 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This 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/rejectVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 5282a9cec6..f21c594795 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index c97ebff62b..c42b0bd8d6 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -12,7 +12,12 @@ atlas api streams startStreamProcessorWith :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index d773623249..1e7f84d19f 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,7 +12,12 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index b641b913d9..d727f29d56 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -12,7 +12,12 @@ atlas api streams updateStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. +`Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index d670acf851..831b882a73 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -12,7 +12,12 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +`Public Preview: please provide feedback `_: Update one stream instance in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 105ab49384..34375e7407 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -12,7 +12,12 @@ atlas api streams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource requires your project ID. @@ -51,36 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. -* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-startStreamProcessorWith` - `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback `_: Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback `_: Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. +* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. +* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback `_: Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-startStreamProcessorWith` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback `_: Update one stream instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index abbc5fcd01..48f37080ac 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,7 +12,12 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. +`Public Preview: please provide feedback `_: Adds one or more teams to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 623c36d7e9..ba4ebf6291 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -12,7 +12,12 @@ atlas api teams addTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +`Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index cb4e7fa9ef..06c03a3832 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -12,7 +12,12 @@ atlas api teams createTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one team in the specified organization. +`Public Preview: please provide feedback `_: Creates one team in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index e29ea0f8e4..0656979460 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -12,7 +12,12 @@ atlas api teams deleteTeam :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 0ec43247c1..b25674370e 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -12,7 +12,12 @@ atlas api teams getTeamById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +`Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index e4ace954e2..46fdd67e9c 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -12,7 +12,12 @@ atlas api teams getTeamByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. +`Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 73bb2d7593..57481f4128 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,7 +12,12 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. +`Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 8a3c0e3c80..a25be5eaae 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -12,7 +12,12 @@ atlas api teams listProjectTeams :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index b2e9495200..7f469b5b7f 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -12,7 +12,12 @@ atlas api teams removeProjectTeam :depth: 1 :class: singlecol -`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. +`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index 7e3c26bd40..a102ed7dd8 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -12,7 +12,12 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index 710a441c5a..6f05792a34 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -12,7 +12,12 @@ atlas api teams renameTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Renames one team in the specified organization. +`Public Preview: please provide feedback `_: Renames one team in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index 03ecaa7caf..f89164856b 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -12,7 +12,12 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +`Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 5ade5ffa12..8a585a0316 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -12,7 +12,14 @@ atlas api teams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,18 +56,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. -* :ref:`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. -* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback at `_: Creates one team in the specified organization. -* :ref:`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. -* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. -* :ref:`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. -* :ref:`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. -* :ref:`atlas-api-teams-removeTeamUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback at `_: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback `_: Adds one or more teams to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback `_: Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - `Public Preview: please provide feedback `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeTeamUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback `_: Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index a63a49d673..5e7f3e0fc9 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. +`Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 029b720bb5..9247c173ca 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. +`Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index 633ffabf43..e3aa2ddde3 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 47cb1025b1..74d23b2c2e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. +`Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 349ec18453..9c02c456ed 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index 6aa78d9c47..64054ce4ff 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud sends alerts to each third-party service that you configure. @@ -54,11 +59,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. .. toctree:: diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index a33c0e8e0b..2b63ddb49d 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,7 +12,12 @@ atlas api x509Authentication createDatabaseUserCertificate :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. +`Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index f5977c8052..b533aa5ed2 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,7 +12,12 @@ atlas api x509Authentication disableCustomerManagedX509 :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +`Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 80a0347146..152547af45 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,7 +12,12 @@ atlas api x509Authentication listDatabaseUserCertificates :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +`Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index c7d7027685..5df3c92d4f 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -12,7 +12,12 @@ atlas api x509Authentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users. @@ -51,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback at `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - `Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - `Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. .. toctree:: diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 8162372064..cab509244e 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,12 @@ atlas api :depth: 1 :class: singlecol -Public Preview: please provide feedback at : Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +`Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. @@ -20,8 +25,8 @@ For more information on - Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access -This feature in public preview streamlines script development by letting you interact -directly with any Atlas Administration API endpoint by using the Atlas CLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Syntax ------ @@ -138,6 +143,7 @@ In addition, the following options are available for all Atlas Administration AP - false - Help for the current command. + Options ------- @@ -173,56 +179,56 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback at `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `Public Preview: please provide feedback at `_: Returns events. -* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback at `_: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - `Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - `Public Preview: please provide feedback at `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback `_: Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - `Public Preview: please provide feedback `_: Returns events. +* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback `_: Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - `Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - `Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. +* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas-auditing-describe.txt b/docs/command/atlas-auditing-describe.txt index d5e7d1b59a..62d2c79cba 100644 --- a/docs/command/atlas-auditing-describe.txt +++ b/docs/command/atlas-auditing-describe.txt @@ -14,6 +14,11 @@ atlas auditing describe Returns the auditing configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-auditing-update.txt b/docs/command/atlas-auditing-update.txt index 9db1566290..8a5fbc5c27 100644 --- a/docs/command/atlas-auditing-update.txt +++ b/docs/command/atlas-auditing-update.txt @@ -14,6 +14,11 @@ atlas auditing update Updates the auditing configuration for the specified project +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-auditing.txt b/docs/command/atlas-auditing.txt index 9a2b9b3290..47fecf31e8 100644 --- a/docs/command/atlas-auditing.txt +++ b/docs/command/atlas-auditing.txt @@ -14,6 +14,13 @@ atlas auditing Returns database auditing settings for MongoDB Cloud projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-auth-login.txt b/docs/command/atlas-auth-login.txt index 689d867fa7..3076bc3039 100644 --- a/docs/command/atlas-auth-login.txt +++ b/docs/command/atlas-auth-login.txt @@ -14,6 +14,13 @@ atlas auth login Authenticate with MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-auth-logout.txt b/docs/command/atlas-auth-logout.txt index 26bae6e33e..279b985afd 100644 --- a/docs/command/atlas-auth-logout.txt +++ b/docs/command/atlas-auth-logout.txt @@ -14,6 +14,13 @@ atlas auth logout Log out of the CLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-auth-register.txt b/docs/command/atlas-auth-register.txt index e61b24277b..10685a269b 100644 --- a/docs/command/atlas-auth-register.txt +++ b/docs/command/atlas-auth-register.txt @@ -14,6 +14,13 @@ atlas auth register Register with MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-auth-whoami.txt b/docs/command/atlas-auth-whoami.txt index 35aabc095e..69303e5542 100644 --- a/docs/command/atlas-auth-whoami.txt +++ b/docs/command/atlas-auth-whoami.txt @@ -14,6 +14,13 @@ atlas auth whoami Verifies and displays information about your authentication state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-auth.txt b/docs/command/atlas-auth.txt index eef0de5289..ad0e97c08a 100644 --- a/docs/command/atlas-auth.txt +++ b/docs/command/atlas-auth.txt @@ -14,6 +14,13 @@ atlas auth Manage the CLI's authentication state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt index 37e4a12583..8d8b80a501 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection disable Disable copy protection of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt index 3887c8ab05..efd9fbfb60 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection enable Enable copy protection of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-copyProtection.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection.txt index 4a57b44306..fa3c107f77 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-describe.txt b/docs/command/atlas-backups-compliancePolicy-describe.txt index 453824e993..187dab9daf 100644 --- a/docs/command/atlas-backups-compliancePolicy-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy describe Return the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-enable.txt b/docs/command/atlas-backups-compliancePolicy-enable.txt index 3050689c0c..b2f47f4806 100644 --- a/docs/command/atlas-backups-compliancePolicy-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy enable Enable Backup Compliance Policy without any configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt index 5cf0a602be..9123d118e4 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest disable Disable encryption-at-rest for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt index ee1b5b3597..c8900d81f6 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest enable Enable encryption-at-rest for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt index 8c4593ff95..9cf4027dce 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt index e304ec1e16..39d59bcb53 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores enable Enable Point-in-Time restores of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt index ef796859c2..e8dac4104b 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-describe.txt index 67682b6086..7c87c85905 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies describe Return the individual policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt index ad02d1aad4..75dfa6dd2f 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand create Create the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt index 574787f69b..ff3f575607 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand describe Return the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt index 5380a584ad..0b78d79dcf 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand update Update the on-demand policy of the backup compliance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt index 4aad7eae1c..7da30510a7 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand Manage the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt index 302052d88a..bc337f85fd 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled create Create a scheduled policy item for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt index f7e60ac25f..2920352a31 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled describe Return the scheduled policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt index 9d2376fa43..fe54c8e26f 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled Manage the scheduled policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies.txt b/docs/command/atlas-backups-compliancePolicy-policies.txt index 40b7bd48d9..0777a61367 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies Manage the individual policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-setup.txt b/docs/command/atlas-backups-compliancePolicy-setup.txt index ab2195d9bd..bfeaa88463 100644 --- a/docs/command/atlas-backups-compliancePolicy-setup.txt +++ b/docs/command/atlas-backups-compliancePolicy-setup.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy setup Setup the backup compliance policy for your project with a configuration file. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-backups-compliancePolicy.txt b/docs/command/atlas-backups-compliancePolicy.txt index b78e1b53db..ca60f97b86 100644 --- a/docs/command/atlas-backups-compliancePolicy.txt +++ b/docs/command/atlas-backups-compliancePolicy.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports-buckets-create.txt b/docs/command/atlas-backups-exports-buckets-create.txt index 484f78bca4..59190cfaa8 100644 --- a/docs/command/atlas-backups-exports-buckets-create.txt +++ b/docs/command/atlas-backups-exports-buckets-create.txt @@ -14,6 +14,11 @@ atlas backups exports buckets create Create an export destination for Atlas backups using an existing AWS S3 bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-delete.txt b/docs/command/atlas-backups-exports-buckets-delete.txt index 2d46d90e33..8758512636 100644 --- a/docs/command/atlas-backups-exports-buckets-delete.txt +++ b/docs/command/atlas-backups-exports-buckets-delete.txt @@ -14,6 +14,11 @@ atlas backups exports buckets delete Delete a snapshot export bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-describe.txt b/docs/command/atlas-backups-exports-buckets-describe.txt index 3d32a61e50..b0ff2017eb 100644 --- a/docs/command/atlas-backups-exports-buckets-describe.txt +++ b/docs/command/atlas-backups-exports-buckets-describe.txt @@ -14,6 +14,11 @@ atlas backups exports buckets describe Return one snapshot export bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-list.txt b/docs/command/atlas-backups-exports-buckets-list.txt index b899715280..16b0e1d303 100644 --- a/docs/command/atlas-backups-exports-buckets-list.txt +++ b/docs/command/atlas-backups-exports-buckets-list.txt @@ -14,6 +14,11 @@ atlas backups exports buckets list List cloud backup restore buckets for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets.txt b/docs/command/atlas-backups-exports-buckets.txt index c72ae83931..bbbceb9282 100644 --- a/docs/command/atlas-backups-exports-buckets.txt +++ b/docs/command/atlas-backups-exports-buckets.txt @@ -14,6 +14,13 @@ atlas backups exports buckets Manage cloud backup export buckets for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports-jobs-create.txt b/docs/command/atlas-backups-exports-jobs-create.txt index 94ce5ccd4e..d025c0f046 100644 --- a/docs/command/atlas-backups-exports-jobs-create.txt +++ b/docs/command/atlas-backups-exports-jobs-create.txt @@ -14,6 +14,11 @@ atlas backups exports jobs create Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-describe.txt b/docs/command/atlas-backups-exports-jobs-describe.txt index 01888b547d..aa5ab5319a 100644 --- a/docs/command/atlas-backups-exports-jobs-describe.txt +++ b/docs/command/atlas-backups-exports-jobs-describe.txt @@ -14,6 +14,11 @@ atlas backups exports jobs describe Return one cloud backup export job for your project, cluster and job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-list.txt b/docs/command/atlas-backups-exports-jobs-list.txt index 7471289e32..8da9bbacbd 100644 --- a/docs/command/atlas-backups-exports-jobs-list.txt +++ b/docs/command/atlas-backups-exports-jobs-list.txt @@ -14,6 +14,11 @@ atlas backups exports jobs list Return all cloud backup export jobs for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-watch.txt b/docs/command/atlas-backups-exports-jobs-watch.txt index c65501c266..317270b0c2 100644 --- a/docs/command/atlas-backups-exports-jobs-watch.txt +++ b/docs/command/atlas-backups-exports-jobs-watch.txt @@ -14,6 +14,11 @@ atlas backups exports jobs watch Watch for the specified export job to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the export job's status periodically until it reaches a completed, cancelled or failed status. Once the export reaches the expected status, the command prints "Export completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-exports-jobs.txt b/docs/command/atlas-backups-exports-jobs.txt index 18641dd17e..15fedcab09 100644 --- a/docs/command/atlas-backups-exports-jobs.txt +++ b/docs/command/atlas-backups-exports-jobs.txt @@ -14,6 +14,13 @@ atlas backups exports jobs Manage cloud backup export jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports.txt b/docs/command/atlas-backups-exports.txt index 1038c8c892..8053b20f0d 100644 --- a/docs/command/atlas-backups-exports.txt +++ b/docs/command/atlas-backups-exports.txt @@ -14,6 +14,13 @@ atlas backups exports Manage cloud backup export jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-restores-describe.txt b/docs/command/atlas-backups-restores-describe.txt index b79ffee197..3108c97b8a 100644 --- a/docs/command/atlas-backups-restores-describe.txt +++ b/docs/command/atlas-backups-restores-describe.txt @@ -14,6 +14,11 @@ atlas backups restores describe Describe a cloud backup restore job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-restores-list.txt b/docs/command/atlas-backups-restores-list.txt index dbbd1f4da7..11a1b79100 100644 --- a/docs/command/atlas-backups-restores-list.txt +++ b/docs/command/atlas-backups-restores-list.txt @@ -14,6 +14,11 @@ atlas backups restores list Return all cloud backup restore jobs for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-restores-start.txt b/docs/command/atlas-backups-restores-start.txt index 5013a092c7..8879525a70 100644 --- a/docs/command/atlas-backups-restores-start.txt +++ b/docs/command/atlas-backups-restores-start.txt @@ -14,6 +14,11 @@ atlas backups restores start Start a restore job for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-restores-watch.txt b/docs/command/atlas-backups-restores-watch.txt index c0f540348f..6debf82c71 100644 --- a/docs/command/atlas-backups-restores-watch.txt +++ b/docs/command/atlas-backups-restores-watch.txt @@ -14,6 +14,11 @@ atlas backups restores watch Watch for a restore job to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. Once the restore reaches the expected status, the command prints "Restore completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-restores.txt b/docs/command/atlas-backups-restores.txt index 5959488c5b..fda2b83f4d 100644 --- a/docs/command/atlas-backups-restores.txt +++ b/docs/command/atlas-backups-restores.txt @@ -14,6 +14,13 @@ atlas backups restores Manage cloud backup restore jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-schedule-delete.txt b/docs/command/atlas-backups-schedule-delete.txt index b78fc1f408..7b9a5ac42a 100644 --- a/docs/command/atlas-backups-schedule-delete.txt +++ b/docs/command/atlas-backups-schedule-delete.txt @@ -14,6 +14,11 @@ atlas backups schedule delete Delete all backup schedules of a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-schedule-describe.txt b/docs/command/atlas-backups-schedule-describe.txt index bc59d3470b..0853985028 100644 --- a/docs/command/atlas-backups-schedule-describe.txt +++ b/docs/command/atlas-backups-schedule-describe.txt @@ -14,6 +14,11 @@ atlas backups schedule describe Describe a cloud backup schedule for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-schedule-update.txt b/docs/command/atlas-backups-schedule-update.txt index aa99e70631..86211468e0 100644 --- a/docs/command/atlas-backups-schedule-update.txt +++ b/docs/command/atlas-backups-schedule-update.txt @@ -14,6 +14,11 @@ atlas backups schedule update Modify the backup schedule for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The backup schedule defines when MongoDB takes scheduled snapshots and how long it stores those snapshots. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-schedule.txt b/docs/command/atlas-backups-schedule.txt index 3b3382244d..8af337ba2f 100644 --- a/docs/command/atlas-backups-schedule.txt +++ b/docs/command/atlas-backups-schedule.txt @@ -14,6 +14,13 @@ atlas backups schedule Return a cloud backup schedule for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups-snapshots-create.txt b/docs/command/atlas-backups-snapshots-create.txt index a9c24f0a57..4a2f813133 100644 --- a/docs/command/atlas-backups-snapshots-create.txt +++ b/docs/command/atlas-backups-snapshots-create.txt @@ -14,6 +14,11 @@ atlas backups snapshots create Create a backup snapshot for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can create on-demand backup snapshots for Atlas cluster tiers M10 and larger. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-snapshots-delete.txt b/docs/command/atlas-backups-snapshots-delete.txt index 99e44b55fc..05c247aaa9 100644 --- a/docs/command/atlas-backups-snapshots-delete.txt +++ b/docs/command/atlas-backups-snapshots-delete.txt @@ -14,6 +14,11 @@ atlas backups snapshots delete Remove the specified backup snapshot. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-backups-snapshots-describe.txt b/docs/command/atlas-backups-snapshots-describe.txt index 20bcc9f6e1..794c70b856 100644 --- a/docs/command/atlas-backups-snapshots-describe.txt +++ b/docs/command/atlas-backups-snapshots-describe.txt @@ -14,6 +14,11 @@ atlas backups snapshots describe Return the details for the specified snapshot for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-snapshots-download.txt b/docs/command/atlas-backups-snapshots-download.txt index 11b570f992..0d18b8aa06 100644 --- a/docs/command/atlas-backups-snapshots-download.txt +++ b/docs/command/atlas-backups-snapshots-download.txt @@ -14,6 +14,11 @@ atlas backups snapshots download Download one snapshot for the specified flex cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can download a snapshot for an Atlas Flex cluster. To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for Flex clusters. diff --git a/docs/command/atlas-backups-snapshots-list.txt b/docs/command/atlas-backups-snapshots-list.txt index 4fee8008ea..ab98629bb9 100644 --- a/docs/command/atlas-backups-snapshots-list.txt +++ b/docs/command/atlas-backups-snapshots-list.txt @@ -14,6 +14,11 @@ atlas backups snapshots list Return all cloud backup snapshots for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-snapshots-watch.txt b/docs/command/atlas-backups-snapshots-watch.txt index f17ed235fc..65a3a2e518 100644 --- a/docs/command/atlas-backups-snapshots-watch.txt +++ b/docs/command/atlas-backups-snapshots-watch.txt @@ -14,6 +14,11 @@ atlas backups snapshots watch Watch the specified snapshot in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the snapshot's status periodically until it reaches a completed or failed status. Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-snapshots.txt b/docs/command/atlas-backups-snapshots.txt index 028c6c021b..8ccde5d6f5 100644 --- a/docs/command/atlas-backups-snapshots.txt +++ b/docs/command/atlas-backups-snapshots.txt @@ -14,6 +14,13 @@ atlas backups snapshots Manage cloud backup snapshots for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-backups.txt b/docs/command/atlas-backups.txt index c04fe26d41..b02fa017ff 100644 --- a/docs/command/atlas-backups.txt +++ b/docs/command/atlas-backups.txt @@ -14,6 +14,13 @@ atlas backups Manage cloud backups for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt index 63807f8d41..9e67b1db57 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws authorize Authorize an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt index d9d9cc95a5..daa56658dd 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws create Create an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt index cdb6f3e25b..5b891c2c41 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws deauthorize Deauthorize an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws.txt b/docs/command/atlas-cloudProviders-accessRoles-aws.txt index 87be4ff42e..136a9d0d90 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws Manage AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders-accessRoles-list.txt b/docs/command/atlas-cloudProviders-accessRoles-list.txt index f547b542a0..e21673a151 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-list.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-list.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles list List AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles.txt b/docs/command/atlas-cloudProviders-accessRoles.txt index a0d5c04fa9..8a932a5bf3 100644 --- a/docs/command/atlas-cloudProviders-accessRoles.txt +++ b/docs/command/atlas-cloudProviders-accessRoles.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles Manage AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders.txt b/docs/command/atlas-cloudProviders.txt index 397bdf243d..36918900f4 100644 --- a/docs/command/atlas-cloudProviders.txt +++ b/docs/command/atlas-cloudProviders.txt @@ -14,6 +14,13 @@ atlas cloudProviders Manage cloud provider access in Atlas using AWS IAM roles. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-advancedSettings-describe.txt b/docs/command/atlas-clusters-advancedSettings-describe.txt index da40aab20e..a799377a6b 100644 --- a/docs/command/atlas-clusters-advancedSettings-describe.txt +++ b/docs/command/atlas-clusters-advancedSettings-describe.txt @@ -14,6 +14,11 @@ atlas clusters advancedSettings describe Retrieve advanced configuration settings for one cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-advancedSettings-update.txt b/docs/command/atlas-clusters-advancedSettings-update.txt index 5017e010ae..39f245aa8f 100644 --- a/docs/command/atlas-clusters-advancedSettings-update.txt +++ b/docs/command/atlas-clusters-advancedSettings-update.txt @@ -14,6 +14,11 @@ atlas clusters advancedSettings update Update advanced configuration settings for one cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + 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. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-advancedSettings.txt b/docs/command/atlas-clusters-advancedSettings.txt index 206c7620db..e88b76fde2 100644 --- a/docs/command/atlas-clusters-advancedSettings.txt +++ b/docs/command/atlas-clusters-advancedSettings.txt @@ -14,6 +14,13 @@ atlas clusters advancedSettings Manage advanced configuration settings for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-availableRegions-list.txt b/docs/command/atlas-clusters-availableRegions-list.txt index e0adf92e91..6443c0e954 100644 --- a/docs/command/atlas-clusters-availableRegions-list.txt +++ b/docs/command/atlas-clusters-availableRegions-list.txt @@ -14,6 +14,13 @@ atlas clusters availableRegions list List available regions that Atlas supports for new deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-clusters-availableRegions.txt b/docs/command/atlas-clusters-availableRegions.txt index 56a43e7f4a..659e4cd7cf 100644 --- a/docs/command/atlas-clusters-availableRegions.txt +++ b/docs/command/atlas-clusters-availableRegions.txt @@ -14,6 +14,13 @@ atlas clusters availableRegions Manage available regions for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-connectionStrings-describe.txt b/docs/command/atlas-clusters-connectionStrings-describe.txt index 92b25f762c..434c26ca79 100644 --- a/docs/command/atlas-clusters-connectionStrings-describe.txt +++ b/docs/command/atlas-clusters-connectionStrings-describe.txt @@ -14,6 +14,11 @@ atlas clusters connectionStrings describe Return the SRV connection string for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-connectionStrings.txt b/docs/command/atlas-clusters-connectionStrings.txt index 0b206d8b56..beaeeb8c14 100644 --- a/docs/command/atlas-clusters-connectionStrings.txt +++ b/docs/command/atlas-clusters-connectionStrings.txt @@ -14,6 +14,13 @@ atlas clusters connectionStrings Manage MongoDB cluster connection string. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-create.txt b/docs/command/atlas-clusters-create.txt index 85bb0364c9..5e274f5784 100644 --- a/docs/command/atlas-clusters-create.txt +++ b/docs/command/atlas-clusters-create.txt @@ -14,6 +14,11 @@ atlas clusters create Create a cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. diff --git a/docs/command/atlas-clusters-delete.txt b/docs/command/atlas-clusters-delete.txt index cf9404e96d..ea1199aa2c 100644 --- a/docs/command/atlas-clusters-delete.txt +++ b/docs/command/atlas-clusters-delete.txt @@ -14,6 +14,11 @@ atlas clusters delete Remove the specified cluster from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting a cluster also deletes any backup snapshots for that cluster. diff --git a/docs/command/atlas-clusters-describe.txt b/docs/command/atlas-clusters-describe.txt index 859d243f87..22e5e2445c 100644 --- a/docs/command/atlas-clusters-describe.txt +++ b/docs/command/atlas-clusters-describe.txt @@ -14,6 +14,11 @@ atlas clusters describe Return the details for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-failover.txt b/docs/command/atlas-clusters-failover.txt index 8d96a5dee8..cac047205c 100644 --- a/docs/command/atlas-clusters-failover.txt +++ b/docs/command/atlas-clusters-failover.txt @@ -14,6 +14,11 @@ atlas clusters failover Starts a failover test for the specified cluster in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + 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. Syntax diff --git a/docs/command/atlas-clusters-indexes-create.txt b/docs/command/atlas-clusters-indexes-create.txt index b0ab8cec36..3b73e401e9 100644 --- a/docs/command/atlas-clusters-indexes-create.txt +++ b/docs/command/atlas-clusters-indexes-create.txt @@ -14,6 +14,11 @@ atlas clusters indexes create Create a rolling index for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-indexes.txt b/docs/command/atlas-clusters-indexes.txt index 2fb07225f6..0b908df2ab 100644 --- a/docs/command/atlas-clusters-indexes.txt +++ b/docs/command/atlas-clusters-indexes.txt @@ -14,6 +14,13 @@ atlas clusters indexes Manage cluster rolling indexes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-list.txt b/docs/command/atlas-clusters-list.txt index 4c6815e5b5..d40af98889 100644 --- a/docs/command/atlas-clusters-list.txt +++ b/docs/command/atlas-clusters-list.txt @@ -14,6 +14,11 @@ atlas clusters list Return all clusters for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-create.txt b/docs/command/atlas-clusters-onlineArchives-create.txt index 807caab592..b7d4e6b1cb 100644 --- a/docs/command/atlas-clusters-onlineArchives-create.txt +++ b/docs/command/atlas-clusters-onlineArchives-create.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives create Create an online archive for a collection in the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can create an online archive for an M10 or larger cluster. To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. diff --git a/docs/command/atlas-clusters-onlineArchives-delete.txt b/docs/command/atlas-clusters-onlineArchives-delete.txt index 1565262de1..1e270f0d5c 100644 --- a/docs/command/atlas-clusters-onlineArchives-delete.txt +++ b/docs/command/atlas-clusters-onlineArchives-delete.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives delete Remove the specified online archive from your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-describe.txt b/docs/command/atlas-clusters-onlineArchives-describe.txt index 61d98b1ab0..b367a735dc 100644 --- a/docs/command/atlas-clusters-onlineArchives-describe.txt +++ b/docs/command/atlas-clusters-onlineArchives-describe.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives describe Return the details for the specified online archive for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-list.txt b/docs/command/atlas-clusters-onlineArchives-list.txt index 31303c36d0..c431fd5954 100644 --- a/docs/command/atlas-clusters-onlineArchives-list.txt +++ b/docs/command/atlas-clusters-onlineArchives-list.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives list Return all online archives for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-pause.txt b/docs/command/atlas-clusters-onlineArchives-pause.txt index 996bf97623..20b2332fe3 100644 --- a/docs/command/atlas-clusters-onlineArchives-pause.txt +++ b/docs/command/atlas-clusters-onlineArchives-pause.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives pause Pause the specfied online archive for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-start.txt b/docs/command/atlas-clusters-onlineArchives-start.txt index 9b9f22efdd..edfaca7889 100644 --- a/docs/command/atlas-clusters-onlineArchives-start.txt +++ b/docs/command/atlas-clusters-onlineArchives-start.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives start Start a paused online archive from a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-update.txt b/docs/command/atlas-clusters-onlineArchives-update.txt index 53ee303d8d..6e147f2b89 100644 --- a/docs/command/atlas-clusters-onlineArchives-update.txt +++ b/docs/command/atlas-clusters-onlineArchives-update.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives update Modify the archiving rule for the specified online archive for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-watch.txt b/docs/command/atlas-clusters-onlineArchives-watch.txt index dd7d016207..0978c01ce4 100644 --- a/docs/command/atlas-clusters-onlineArchives-watch.txt +++ b/docs/command/atlas-clusters-onlineArchives-watch.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives watch Watch for an archive to be available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. diff --git a/docs/command/atlas-clusters-onlineArchives.txt b/docs/command/atlas-clusters-onlineArchives.txt index b689acf59a..bd566ac194 100644 --- a/docs/command/atlas-clusters-onlineArchives.txt +++ b/docs/command/atlas-clusters-onlineArchives.txt @@ -14,6 +14,13 @@ atlas clusters onlineArchives Manage online archives for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-pause.txt b/docs/command/atlas-clusters-pause.txt index 6f369603dc..9ee26227ac 100644 --- a/docs/command/atlas-clusters-pause.txt +++ b/docs/command/atlas-clusters-pause.txt @@ -14,6 +14,11 @@ atlas clusters pause Pause the specified running MongoDB cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-sampleData-describe.txt b/docs/command/atlas-clusters-sampleData-describe.txt index 4582679f53..29b6c531cf 100644 --- a/docs/command/atlas-clusters-sampleData-describe.txt +++ b/docs/command/atlas-clusters-sampleData-describe.txt @@ -14,6 +14,11 @@ atlas clusters sampleData describe Return the details for the specified sample data load job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-sampleData-load.txt b/docs/command/atlas-clusters-sampleData-load.txt index 89f96848c5..bec2a5b68d 100644 --- a/docs/command/atlas-clusters-sampleData-load.txt +++ b/docs/command/atlas-clusters-sampleData-load.txt @@ -14,6 +14,11 @@ atlas clusters sampleData load Load sample data into the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-sampleData-watch.txt b/docs/command/atlas-clusters-sampleData-watch.txt index 6999b01897..5546b53d64 100644 --- a/docs/command/atlas-clusters-sampleData-watch.txt +++ b/docs/command/atlas-clusters-sampleData-watch.txt @@ -14,6 +14,11 @@ atlas clusters sampleData watch Watch the specified sample data job in your cluster until it completes. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the sample data job's status periodically until it reaches an COMPLETED state. If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. You can interrupt the command's polling at any time with CTRL-C. diff --git a/docs/command/atlas-clusters-sampleData.txt b/docs/command/atlas-clusters-sampleData.txt index 60fb597813..1b8dedeb94 100644 --- a/docs/command/atlas-clusters-sampleData.txt +++ b/docs/command/atlas-clusters-sampleData.txt @@ -14,6 +14,11 @@ atlas clusters sampleData Manage sample data for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The sampleData command provides access to sample data to be loaded onto your cluster. Options diff --git a/docs/command/atlas-clusters-search-indexes-create.txt b/docs/command/atlas-clusters-search-indexes-create.txt index 798abf7b66..b33966e2d9 100644 --- a/docs/command/atlas-clusters-search-indexes-create.txt +++ b/docs/command/atlas-clusters-search-indexes-create.txt @@ -14,6 +14,11 @@ atlas clusters search indexes create Create a search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-delete.txt b/docs/command/atlas-clusters-search-indexes-delete.txt index 7541ce1050..f25f528d2e 100644 --- a/docs/command/atlas-clusters-search-indexes-delete.txt +++ b/docs/command/atlas-clusters-search-indexes-delete.txt @@ -14,6 +14,11 @@ atlas clusters search indexes delete Delete the specified search index from the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-describe.txt b/docs/command/atlas-clusters-search-indexes-describe.txt index eef63fa825..d517a5a841 100644 --- a/docs/command/atlas-clusters-search-indexes-describe.txt +++ b/docs/command/atlas-clusters-search-indexes-describe.txt @@ -14,6 +14,11 @@ atlas clusters search indexes describe Return the details for the search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-list.txt b/docs/command/atlas-clusters-search-indexes-list.txt index e17eb4d23a..b0f4e58a67 100644 --- a/docs/command/atlas-clusters-search-indexes-list.txt +++ b/docs/command/atlas-clusters-search-indexes-list.txt @@ -14,6 +14,11 @@ atlas clusters search indexes list List all Atlas Search indexes for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-update.txt b/docs/command/atlas-clusters-search-indexes-update.txt index 87c5a17dd3..e3edfec242 100644 --- a/docs/command/atlas-clusters-search-indexes-update.txt +++ b/docs/command/atlas-clusters-search-indexes-update.txt @@ -14,6 +14,11 @@ atlas clusters search indexes update Modify a search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes.txt b/docs/command/atlas-clusters-search-indexes.txt index 160e679678..df172b1461 100644 --- a/docs/command/atlas-clusters-search-indexes.txt +++ b/docs/command/atlas-clusters-search-indexes.txt @@ -14,6 +14,13 @@ atlas clusters search indexes Manage Atlas Search indexes for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-search-nodes-create.txt b/docs/command/atlas-clusters-search-nodes-create.txt index b60cc0fa92..51cf4881d6 100644 --- a/docs/command/atlas-clusters-search-nodes-create.txt +++ b/docs/command/atlas-clusters-search-nodes-create.txt @@ -14,6 +14,11 @@ atlas clusters search nodes create Create a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-delete.txt b/docs/command/atlas-clusters-search-nodes-delete.txt index fff9832631..5666a2097b 100644 --- a/docs/command/atlas-clusters-search-nodes-delete.txt +++ b/docs/command/atlas-clusters-search-nodes-delete.txt @@ -14,6 +14,11 @@ atlas clusters search nodes delete Delete a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-list.txt b/docs/command/atlas-clusters-search-nodes-list.txt index c0d3460121..4c2c81751b 100644 --- a/docs/command/atlas-clusters-search-nodes-list.txt +++ b/docs/command/atlas-clusters-search-nodes-list.txt @@ -14,6 +14,11 @@ atlas clusters search nodes list List all Atlas Search nodes for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-update.txt b/docs/command/atlas-clusters-search-nodes-update.txt index bab41d6284..4d1f31d834 100644 --- a/docs/command/atlas-clusters-search-nodes-update.txt +++ b/docs/command/atlas-clusters-search-nodes-update.txt @@ -14,6 +14,11 @@ atlas clusters search nodes update Update a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes.txt b/docs/command/atlas-clusters-search-nodes.txt index 958a089711..15c2497387 100644 --- a/docs/command/atlas-clusters-search-nodes.txt +++ b/docs/command/atlas-clusters-search-nodes.txt @@ -14,6 +14,13 @@ atlas clusters search nodes Manage Atlas Search nodes for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-search.txt b/docs/command/atlas-clusters-search.txt index d8ffd2b0ba..0cf13ee0ae 100644 --- a/docs/command/atlas-clusters-search.txt +++ b/docs/command/atlas-clusters-search.txt @@ -14,6 +14,13 @@ atlas clusters search Manage Atlas Search for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-start.txt b/docs/command/atlas-clusters-start.txt index 943c8f079f..785cfb5f69 100644 --- a/docs/command/atlas-clusters-start.txt +++ b/docs/command/atlas-clusters-start.txt @@ -14,6 +14,11 @@ atlas clusters start Start the specified paused MongoDB cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-update.txt b/docs/command/atlas-clusters-update.txt index 3275c92b1f..2f286682f8 100644 --- a/docs/command/atlas-clusters-update.txt +++ b/docs/command/atlas-clusters-update.txt @@ -14,6 +14,11 @@ atlas clusters update Modify the settings of the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can specify modifications in a JSON configuration file with the --file flag. You can't change the name of the cluster or downgrade the MongoDB version of your cluster. diff --git a/docs/command/atlas-clusters-upgrade.txt b/docs/command/atlas-clusters-upgrade.txt index 59b913b58a..5e8a33089a 100644 --- a/docs/command/atlas-clusters-upgrade.txt +++ b/docs/command/atlas-clusters-upgrade.txt @@ -14,6 +14,11 @@ atlas clusters upgrade Upgrade a shared cluster's tier, disk size, and/or MongoDB version. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command is unavailable for dedicated clusters. To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. diff --git a/docs/command/atlas-clusters-watch.txt b/docs/command/atlas-clusters-watch.txt index 9370e54689..d5fd242dd8 100644 --- a/docs/command/atlas-clusters-watch.txt +++ b/docs/command/atlas-clusters-watch.txt @@ -14,6 +14,11 @@ atlas clusters watch Watch the specified cluster in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the cluster's status periodically until it reaches an IDLE state. Once the cluster reaches the expected state, the command prints "Cluster available." If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. diff --git a/docs/command/atlas-clusters.txt b/docs/command/atlas-clusters.txt index 5f49f0d466..898080279d 100644 --- a/docs/command/atlas-clusters.txt +++ b/docs/command/atlas-clusters.txt @@ -14,6 +14,11 @@ atlas clusters Manage clusters for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. Options diff --git a/docs/command/atlas-completion-fish.txt b/docs/command/atlas-completion-fish.txt index cdb18085f7..88493a2445 100644 --- a/docs/command/atlas-completion-fish.txt +++ b/docs/command/atlas-completion-fish.txt @@ -14,6 +14,11 @@ atlas completion fish Generate the autocompletion script for fish +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for the fish shell. To load completions in your current shell session: diff --git a/docs/command/atlas-completion-powershell.txt b/docs/command/atlas-completion-powershell.txt index 4ec9d22b11..92864e69de 100644 --- a/docs/command/atlas-completion-powershell.txt +++ b/docs/command/atlas-completion-powershell.txt @@ -14,6 +14,11 @@ atlas completion powershell Generate the autocompletion script for powershell +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for powershell. To load completions in your current shell session: diff --git a/docs/command/atlas-completion-zsh.txt b/docs/command/atlas-completion-zsh.txt index f5052fa504..39ddc5fbaa 100644 --- a/docs/command/atlas-completion-zsh.txt +++ b/docs/command/atlas-completion-zsh.txt @@ -14,6 +14,11 @@ atlas completion zsh Generate the autocompletion script for zsh +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for the zsh shell. If shell completion is not already enabled in your environment you will need diff --git a/docs/command/atlas-completion.txt b/docs/command/atlas-completion.txt index 57d74af29c..8ae0cc0b34 100644 --- a/docs/command/atlas-completion.txt +++ b/docs/command/atlas-completion.txt @@ -14,6 +14,11 @@ atlas completion Generate the autocompletion script for the specified shell +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for atlas for the specified shell. See each sub-command's help for details on how to use the generated script. diff --git a/docs/command/atlas-config-delete.txt b/docs/command/atlas-config-delete.txt index 767cc09906..37d961a176 100644 --- a/docs/command/atlas-config-delete.txt +++ b/docs/command/atlas-config-delete.txt @@ -14,6 +14,13 @@ atlas config delete Delete a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-config-describe.txt b/docs/command/atlas-config-describe.txt index 56359f1812..b1911dcf9b 100644 --- a/docs/command/atlas-config-describe.txt +++ b/docs/command/atlas-config-describe.txt @@ -14,6 +14,13 @@ atlas config describe Return the profile you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-config-edit.txt b/docs/command/atlas-config-edit.txt index 3f79872c73..ec1478b022 100644 --- a/docs/command/atlas-config-edit.txt +++ b/docs/command/atlas-config-edit.txt @@ -14,6 +14,11 @@ atlas config edit Opens the config file with the default text editor. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. Syntax diff --git a/docs/command/atlas-config-init.txt b/docs/command/atlas-config-init.txt index 5869b38318..8f19185975 100644 --- a/docs/command/atlas-config-init.txt +++ b/docs/command/atlas-config-init.txt @@ -14,6 +14,13 @@ atlas config init Configure a profile to store access settings for your MongoDB deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-config-list.txt b/docs/command/atlas-config-list.txt index 36cee08ac7..f4d337930e 100644 --- a/docs/command/atlas-config-list.txt +++ b/docs/command/atlas-config-list.txt @@ -14,6 +14,11 @@ atlas config list Return a list of available profiles by name. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you did not specify a name for your profile, it displays as the default profile. Syntax diff --git a/docs/command/atlas-config-rename.txt b/docs/command/atlas-config-rename.txt index cd801e52d7..f0ab398ac8 100644 --- a/docs/command/atlas-config-rename.txt +++ b/docs/command/atlas-config-rename.txt @@ -14,6 +14,13 @@ atlas config rename Rename a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-config-set.txt b/docs/command/atlas-config-set.txt index dd1be889b6..b2bf1ec57c 100644 --- a/docs/command/atlas-config-set.txt +++ b/docs/command/atlas-config-set.txt @@ -14,6 +14,13 @@ atlas config set Configure specific properties of a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-config.txt b/docs/command/atlas-config.txt index 407faf6a3a..14f6b198bb 100644 --- a/docs/command/atlas-config.txt +++ b/docs/command/atlas-config.txt @@ -14,6 +14,11 @@ atlas config Configure and manage your user profiles. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Configure settings in a user profile. All settings are optional. You can specify settings individually by running: $ atlas config set --help diff --git a/docs/command/atlas-customDbRoles-create.txt b/docs/command/atlas-customDbRoles-create.txt index 9b8a215906..1e5ab98d89 100644 --- a/docs/command/atlas-customDbRoles-create.txt +++ b/docs/command/atlas-customDbRoles-create.txt @@ -14,6 +14,11 @@ atlas customDbRoles create Create a custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles-delete.txt b/docs/command/atlas-customDbRoles-delete.txt index 15ac1aa8a1..eba3c574de 100644 --- a/docs/command/atlas-customDbRoles-delete.txt +++ b/docs/command/atlas-customDbRoles-delete.txt @@ -14,6 +14,11 @@ atlas customDbRoles delete Remove the specified custom database role from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles-describe.txt b/docs/command/atlas-customDbRoles-describe.txt index fc55e02673..10cae21512 100644 --- a/docs/command/atlas-customDbRoles-describe.txt +++ b/docs/command/atlas-customDbRoles-describe.txt @@ -14,6 +14,11 @@ atlas customDbRoles describe Return a single custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDbRoles-list.txt b/docs/command/atlas-customDbRoles-list.txt index 68e8f8d518..8e256bf775 100644 --- a/docs/command/atlas-customDbRoles-list.txt +++ b/docs/command/atlas-customDbRoles-list.txt @@ -14,6 +14,11 @@ atlas customDbRoles list List custom database roles for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDbRoles-update.txt b/docs/command/atlas-customDbRoles-update.txt index eb665640dc..619ca0f433 100644 --- a/docs/command/atlas-customDbRoles-update.txt +++ b/docs/command/atlas-customDbRoles-update.txt @@ -14,6 +14,11 @@ atlas customDbRoles update Update a custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles.txt b/docs/command/atlas-customDbRoles.txt index 674eaa626a..ec12e4f561 100644 --- a/docs/command/atlas-customDbRoles.txt +++ b/docs/command/atlas-customDbRoles.txt @@ -14,6 +14,13 @@ atlas customDbRoles Manage custom database roles for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-customDns-aws-describe.txt b/docs/command/atlas-customDns-aws-describe.txt index f19e00caa6..d25889d6c5 100644 --- a/docs/command/atlas-customDns-aws-describe.txt +++ b/docs/command/atlas-customDns-aws-describe.txt @@ -14,6 +14,11 @@ atlas customDns aws describe Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDns-aws-disable.txt b/docs/command/atlas-customDns-aws-disable.txt index fe8931480d..998a037f19 100644 --- a/docs/command/atlas-customDns-aws-disable.txt +++ b/docs/command/atlas-customDns-aws-disable.txt @@ -14,6 +14,11 @@ atlas customDns aws disable Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDns-aws-enable.txt b/docs/command/atlas-customDns-aws-enable.txt index 7ebf795a8b..e42dec039e 100644 --- a/docs/command/atlas-customDns-aws-enable.txt +++ b/docs/command/atlas-customDns-aws-enable.txt @@ -14,6 +14,11 @@ atlas customDns aws enable Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDns-aws.txt b/docs/command/atlas-customDns-aws.txt index 2b385960ad..7c0ae6f4c5 100644 --- a/docs/command/atlas-customDns-aws.txt +++ b/docs/command/atlas-customDns-aws.txt @@ -14,6 +14,13 @@ atlas customDns aws Manage DNS configuration of an Atlas project’s cluster deployed to AWS. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-customDns.txt b/docs/command/atlas-customDns.txt index a613a48d18..a1acf0bf97 100644 --- a/docs/command/atlas-customDns.txt +++ b/docs/command/atlas-customDns.txt @@ -14,6 +14,13 @@ atlas customDns Manage DNS configuration of Atlas project’s clusters deployed to AWS. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-create.txt b/docs/command/atlas-dataFederation-create.txt index cb56350eae..d5de6d016c 100644 --- a/docs/command/atlas-dataFederation-create.txt +++ b/docs/command/atlas-dataFederation-create.txt @@ -14,6 +14,11 @@ atlas dataFederation create Creates a new Data Federation database. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-delete.txt b/docs/command/atlas-dataFederation-delete.txt index e382667aa3..46080bd311 100644 --- a/docs/command/atlas-dataFederation-delete.txt +++ b/docs/command/atlas-dataFederation-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation delete Remove the specified data federation database from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-describe.txt b/docs/command/atlas-dataFederation-describe.txt index 5499f34860..ec1c187e05 100644 --- a/docs/command/atlas-dataFederation-describe.txt +++ b/docs/command/atlas-dataFederation-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation describe Return the details for the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-list.txt b/docs/command/atlas-dataFederation-list.txt index 59c6ee9682..e61d582ca0 100644 --- a/docs/command/atlas-dataFederation-list.txt +++ b/docs/command/atlas-dataFederation-list.txt @@ -14,6 +14,11 @@ atlas dataFederation list Returns all data federation databases for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-logs.txt b/docs/command/atlas-dataFederation-logs.txt index 708beaf639..6a780c1390 100644 --- a/docs/command/atlas-dataFederation-logs.txt +++ b/docs/command/atlas-dataFederation-logs.txt @@ -14,6 +14,11 @@ atlas dataFederation logs Returns logs of the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-create.txt b/docs/command/atlas-dataFederation-privateEndpoints-create.txt index 92cbbefc52..3ce4302f69 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-create.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-create.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints create Creates a new Data Federation private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt index b120e76382..19b005a764 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints delete Remove the specified data federation private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt index f6c4a32295..fb88777c7a 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints describe Return the details for the specified data federation private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-list.txt b/docs/command/atlas-dataFederation-privateEndpoints-list.txt index 11c74755fa..975143246d 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-list.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-list.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints list Returns all data federation private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints.txt b/docs/command/atlas-dataFederation-privateEndpoints.txt index 2bb92609a9..8648735cde 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints.txt @@ -14,6 +14,13 @@ atlas dataFederation privateEndpoints Data federation private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-queryLimits-create.txt b/docs/command/atlas-dataFederation-queryLimits-create.txt index eaa5f1f2cf..32d7ac2672 100644 --- a/docs/command/atlas-dataFederation-queryLimits-create.txt +++ b/docs/command/atlas-dataFederation-queryLimits-create.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits create Creates a new Data Federation query limit. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-delete.txt b/docs/command/atlas-dataFederation-queryLimits-delete.txt index 3291c783d6..dcb374aaaa 100644 --- a/docs/command/atlas-dataFederation-queryLimits-delete.txt +++ b/docs/command/atlas-dataFederation-queryLimits-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits delete Remove the specified data federation query limit from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-describe.txt b/docs/command/atlas-dataFederation-queryLimits-describe.txt index 63f1b1b213..ccf46e5925 100644 --- a/docs/command/atlas-dataFederation-queryLimits-describe.txt +++ b/docs/command/atlas-dataFederation-queryLimits-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits describe Return the details for the specified data federation query limit for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-list.txt b/docs/command/atlas-dataFederation-queryLimits-list.txt index 9f30232375..8408b8bf69 100644 --- a/docs/command/atlas-dataFederation-queryLimits-list.txt +++ b/docs/command/atlas-dataFederation-queryLimits-list.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits list Returns all data federation query limits for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits.txt b/docs/command/atlas-dataFederation-queryLimits.txt index 9667d5ede8..16bec56f2e 100644 --- a/docs/command/atlas-dataFederation-queryLimits.txt +++ b/docs/command/atlas-dataFederation-queryLimits.txt @@ -14,6 +14,13 @@ atlas dataFederation queryLimits Data federation query limits. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-update.txt b/docs/command/atlas-dataFederation-update.txt index 9efe96d462..3600b5c81f 100644 --- a/docs/command/atlas-dataFederation-update.txt +++ b/docs/command/atlas-dataFederation-update.txt @@ -14,6 +14,11 @@ atlas dataFederation update Modify the details of the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation.txt b/docs/command/atlas-dataFederation.txt index f548e43470..585465dd3e 100644 --- a/docs/command/atlas-dataFederation.txt +++ b/docs/command/atlas-dataFederation.txt @@ -14,6 +14,13 @@ atlas dataFederation Data federation. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-dbusers-certs-create.txt b/docs/command/atlas-dbusers-certs-create.txt index a5771b97af..283c7a416c 100644 --- a/docs/command/atlas-dbusers-certs-create.txt +++ b/docs/command/atlas-dbusers-certs-create.txt @@ -14,6 +14,11 @@ atlas dbusers certs create Create a new Atlas-managed X.509 certificate for the specified database user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. Syntax diff --git a/docs/command/atlas-dbusers-certs-list.txt b/docs/command/atlas-dbusers-certs-list.txt index fd6999647e..d3d5556f54 100644 --- a/docs/command/atlas-dbusers-certs-list.txt +++ b/docs/command/atlas-dbusers-certs-list.txt @@ -14,6 +14,11 @@ atlas dbusers certs list Return all Atlas-managed, unexpired X.509 certificates for the specified database user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. The user you specify must authenticate using X.509 certificates. diff --git a/docs/command/atlas-dbusers-certs.txt b/docs/command/atlas-dbusers-certs.txt index e5cf674a70..fa3cea6d57 100644 --- a/docs/command/atlas-dbusers-certs.txt +++ b/docs/command/atlas-dbusers-certs.txt @@ -14,6 +14,13 @@ atlas dbusers certs Manage Atlas x509 certificates for your database users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-dbusers-create.txt b/docs/command/atlas-dbusers-create.txt index 53cf35d052..36cc6c8686 100644 --- a/docs/command/atlas-dbusers-create.txt +++ b/docs/command/atlas-dbusers-create.txt @@ -14,6 +14,11 @@ atlas dbusers create Create a database user for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-dbusers-delete.txt b/docs/command/atlas-dbusers-delete.txt index 78e7aec17f..07b6d47976 100644 --- a/docs/command/atlas-dbusers-delete.txt +++ b/docs/command/atlas-dbusers-delete.txt @@ -14,6 +14,11 @@ atlas dbusers delete Remove the specified database user from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dbusers-describe.txt b/docs/command/atlas-dbusers-describe.txt index 275db941a8..0eda7d3385 100644 --- a/docs/command/atlas-dbusers-describe.txt +++ b/docs/command/atlas-dbusers-describe.txt @@ -14,6 +14,11 @@ atlas dbusers describe Return the details for the specified database user for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dbusers-list.txt b/docs/command/atlas-dbusers-list.txt index cebb33b69f..71f5832561 100644 --- a/docs/command/atlas-dbusers-list.txt +++ b/docs/command/atlas-dbusers-list.txt @@ -14,6 +14,11 @@ atlas dbusers list Return all database users for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dbusers-update.txt b/docs/command/atlas-dbusers-update.txt index 55583100e8..bd178e4ab3 100644 --- a/docs/command/atlas-dbusers-update.txt +++ b/docs/command/atlas-dbusers-update.txt @@ -14,6 +14,11 @@ atlas dbusers update Modify the details of a database user in your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dbusers.txt b/docs/command/atlas-dbusers.txt index bf2938b99d..1b8e01d1a5 100644 --- a/docs/command/atlas-dbusers.txt +++ b/docs/command/atlas-dbusers.txt @@ -14,6 +14,11 @@ atlas dbusers Manage database users for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The dbusers command retrieves, creates and modifies the MongoDB database users in your project. Each user has a set of roles that provide access to the project’s databases. A user’s roles apply to all the clusters in the project. diff --git a/docs/command/atlas-deployments-connect.txt b/docs/command/atlas-deployments-connect.txt index ba7a01e12e..5b1d66b10b 100644 --- a/docs/command/atlas-deployments-connect.txt +++ b/docs/command/atlas-deployments-connect.txt @@ -14,6 +14,13 @@ atlas deployments connect Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-delete.txt b/docs/command/atlas-deployments-delete.txt index 7da47cbad1..e6f063c2c6 100644 --- a/docs/command/atlas-deployments-delete.txt +++ b/docs/command/atlas-deployments-delete.txt @@ -14,6 +14,11 @@ atlas deployments delete Delete a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting an Atlas deployment also deletes any backup snapshots for that cluster. diff --git a/docs/command/atlas-deployments-list.txt b/docs/command/atlas-deployments-list.txt index 6cd4592154..c1f02a3a97 100644 --- a/docs/command/atlas-deployments-list.txt +++ b/docs/command/atlas-deployments-list.txt @@ -14,6 +14,13 @@ atlas deployments list Return all deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-logs.txt b/docs/command/atlas-deployments-logs.txt index 9d4c889676..db3399045b 100644 --- a/docs/command/atlas-deployments-logs.txt +++ b/docs/command/atlas-deployments-logs.txt @@ -14,6 +14,13 @@ atlas deployments logs Get deployment logs. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-pause.txt b/docs/command/atlas-deployments-pause.txt index 0508178d28..5d5f05cab9 100644 --- a/docs/command/atlas-deployments-pause.txt +++ b/docs/command/atlas-deployments-pause.txt @@ -14,6 +14,13 @@ atlas deployments pause Pause a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-search-indexes-create.txt b/docs/command/atlas-deployments-search-indexes-create.txt index 6948f1a187..692d8f40f5 100644 --- a/docs/command/atlas-deployments-search-indexes-create.txt +++ b/docs/command/atlas-deployments-search-indexes-create.txt @@ -14,6 +14,13 @@ atlas deployments search indexes create Create a search index for the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-search-indexes-delete.txt b/docs/command/atlas-deployments-search-indexes-delete.txt index 49f5287e6b..51de8a1b6f 100644 --- a/docs/command/atlas-deployments-search-indexes-delete.txt +++ b/docs/command/atlas-deployments-search-indexes-delete.txt @@ -14,6 +14,13 @@ atlas deployments search indexes delete Delete the specified search index from the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-search-indexes-describe.txt b/docs/command/atlas-deployments-search-indexes-describe.txt index fef7fb2e84..adf5bc3f48 100644 --- a/docs/command/atlas-deployments-search-indexes-describe.txt +++ b/docs/command/atlas-deployments-search-indexes-describe.txt @@ -14,6 +14,13 @@ atlas deployments search indexes describe Describe a search index for the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-search-indexes-list.txt b/docs/command/atlas-deployments-search-indexes-list.txt index 75ba7080a4..0123dd23c9 100644 --- a/docs/command/atlas-deployments-search-indexes-list.txt +++ b/docs/command/atlas-deployments-search-indexes-list.txt @@ -14,6 +14,13 @@ atlas deployments search indexes list List all Atlas Search indexes for a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-deployments-search-indexes.txt b/docs/command/atlas-deployments-search-indexes.txt index e585c945e0..31457d7c0e 100644 --- a/docs/command/atlas-deployments-search-indexes.txt +++ b/docs/command/atlas-deployments-search-indexes.txt @@ -14,6 +14,13 @@ atlas deployments search indexes Manage cloud and local search indexes. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-deployments-search.txt b/docs/command/atlas-deployments-search.txt index dc0b73c8b1..bcfca8d071 100644 --- a/docs/command/atlas-deployments-search.txt +++ b/docs/command/atlas-deployments-search.txt @@ -14,6 +14,13 @@ atlas deployments search Manage search for cloud and local deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-deployments-setup.txt b/docs/command/atlas-deployments-setup.txt index b492957bb7..3aeb5a4536 100644 --- a/docs/command/atlas-deployments-setup.txt +++ b/docs/command/atlas-deployments-setup.txt @@ -14,6 +14,11 @@ atlas deployments setup Create a local deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about local atlas deployments, see https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/ Syntax diff --git a/docs/command/atlas-deployments-start.txt b/docs/command/atlas-deployments-start.txt index 803e81ada9..377cade0d4 100644 --- a/docs/command/atlas-deployments-start.txt +++ b/docs/command/atlas-deployments-start.txt @@ -14,6 +14,11 @@ atlas deployments start Start a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you stop a machine, it goes into sleep mode, or restarts. Syntax diff --git a/docs/command/atlas-deployments.txt b/docs/command/atlas-deployments.txt index fea6b69c08..e6975458d4 100644 --- a/docs/command/atlas-deployments.txt +++ b/docs/command/atlas-deployments.txt @@ -14,6 +14,13 @@ atlas deployments Manage cloud and local deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-events-organizations-list.txt b/docs/command/atlas-events-organizations-list.txt index 86fc6039d1..7a409fdc4b 100644 --- a/docs/command/atlas-events-organizations-list.txt +++ b/docs/command/atlas-events-organizations-list.txt @@ -14,6 +14,13 @@ atlas events organizations list Return all events for the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-events-organizations.txt b/docs/command/atlas-events-organizations.txt index aca25de921..b9d1601018 100644 --- a/docs/command/atlas-events-organizations.txt +++ b/docs/command/atlas-events-organizations.txt @@ -14,6 +14,11 @@ atlas events organizations Organization operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + List organization events. Options diff --git a/docs/command/atlas-events-projects-list.txt b/docs/command/atlas-events-projects-list.txt index 06ea1ee489..e117c106c5 100644 --- a/docs/command/atlas-events-projects-list.txt +++ b/docs/command/atlas-events-projects-list.txt @@ -14,6 +14,13 @@ atlas events projects list Return all events for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-events-projects.txt b/docs/command/atlas-events-projects.txt index 1eeef0b881..8ac9f391a7 100644 --- a/docs/command/atlas-events-projects.txt +++ b/docs/command/atlas-events-projects.txt @@ -14,6 +14,11 @@ atlas events projects Project operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + List projects events. Options diff --git a/docs/command/atlas-events.txt b/docs/command/atlas-events.txt index 83e44e0a93..09d6aea497 100644 --- a/docs/command/atlas-events.txt +++ b/docs/command/atlas-events.txt @@ -14,6 +14,13 @@ atlas events Manage events for your organization or project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt index 849ea4f68f..4cb091bc72 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs connect Connect an Identity Provider to an Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt index 47ac1a50b4..8e022877e9 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs delete Delete a connected org config Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt index 0986820f52..8b4830223e 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs describe Describe a Connected Org Config. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt index aa8916a3f1..da51de9fd9 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect Connect an Identity Provider to an Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt index 7093c3112f..289b13e617 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs list Describe a Connected Org Config. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt index 5f4a07a49c..47025edae2 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs update Update One Org Config Connected to One Federation Setting. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt index 5f21f5853f..e888100644 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs Manage Atlas Federated Authentication Connected Orgs Config +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt index faa2be9d24..ddf67b05cf 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings describe Return the Federation Settings details for the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt index 633761f322..880de1ea4f 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create oidc Create an OIDC identity provider. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt index 58d31e6349..dd5cd1cb44 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create Create Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt index c0aaad11b2..1c237b3189 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider delete Remove the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt index 1977c6cda7..fc6d536c49 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider describe Describe the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt index e0a92bbcd7..e359263f83 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider list List the identity providers from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt index 99f29fd56a..7ae06838a2 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider revokeJwk Revoke the JWK token from the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt index 1b1ae15028..1d8e798f9e 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update oidc Update an OIDC identity provider. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt index 9ced3f51a8..6c617f0172 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update Update Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt index 26ea30cb0a..489fbcf667 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider Manage Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings.txt b/docs/command/atlas-federatedAuthentication-federationSettings.txt index 65ff2f3863..c90d028463 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings Manage Atlas Federated Authentication Federation Settings +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication.txt b/docs/command/atlas-federatedAuthentication.txt index 20e4ac2898..a07a2984f8 100644 --- a/docs/command/atlas-federatedAuthentication.txt +++ b/docs/command/atlas-federatedAuthentication.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication Manage Atlas Federated Authentication. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-integrations-create-DATADOG.txt b/docs/command/atlas-integrations-create-DATADOG.txt index 4ff69b54d8..623e7478e9 100644 --- a/docs/command/atlas-integrations-create-DATADOG.txt +++ b/docs/command/atlas-integrations-create-DATADOG.txt @@ -14,6 +14,11 @@ atlas integrations create DATADOG Create or update a Datadog integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. diff --git a/docs/command/atlas-integrations-create-OPS_GENIE.txt b/docs/command/atlas-integrations-create-OPS_GENIE.txt index f379cf6c82..6a510190df 100644 --- a/docs/command/atlas-integrations-create-OPS_GENIE.txt +++ b/docs/command/atlas-integrations-create-OPS_GENIE.txt @@ -14,6 +14,11 @@ atlas integrations create OPS_GENIE Create or update an Opsgenie integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create-PAGER_DUTY.txt b/docs/command/atlas-integrations-create-PAGER_DUTY.txt index 4772a69a43..2cefcd5628 100644 --- a/docs/command/atlas-integrations-create-PAGER_DUTY.txt +++ b/docs/command/atlas-integrations-create-PAGER_DUTY.txt @@ -14,6 +14,11 @@ atlas integrations create PAGER_DUTY Create or update a PagerDuty integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create-VICTOR_OPS.txt b/docs/command/atlas-integrations-create-VICTOR_OPS.txt index 8c7bf304a2..e626922f97 100644 --- a/docs/command/atlas-integrations-create-VICTOR_OPS.txt +++ b/docs/command/atlas-integrations-create-VICTOR_OPS.txt @@ -14,6 +14,11 @@ atlas integrations create VICTOR_OPS Create or update a Splunk On-Call integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + VictorOps is now Splunk On-Call. The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. diff --git a/docs/command/atlas-integrations-create-WEBHOOK.txt b/docs/command/atlas-integrations-create-WEBHOOK.txt index 32dccd71c0..9abb2a4304 100644 --- a/docs/command/atlas-integrations-create-WEBHOOK.txt +++ b/docs/command/atlas-integrations-create-WEBHOOK.txt @@ -14,6 +14,11 @@ atlas integrations create WEBHOOK Create or update a webhook integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create.txt b/docs/command/atlas-integrations-create.txt index 85048bcdb1..5daecc739c 100644 --- a/docs/command/atlas-integrations-create.txt +++ b/docs/command/atlas-integrations-create.txt @@ -14,6 +14,13 @@ atlas integrations create Create operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-integrations-delete.txt b/docs/command/atlas-integrations-delete.txt index 63239e640e..c81f01844e 100644 --- a/docs/command/atlas-integrations-delete.txt +++ b/docs/command/atlas-integrations-delete.txt @@ -14,6 +14,11 @@ atlas integrations delete Remove the specified third-party integration from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-describe.txt b/docs/command/atlas-integrations-describe.txt index 8d00468824..9236f280c9 100644 --- a/docs/command/atlas-integrations-describe.txt +++ b/docs/command/atlas-integrations-describe.txt @@ -14,6 +14,11 @@ atlas integrations describe Return the details for the specified third-party integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-integrations-list.txt b/docs/command/atlas-integrations-list.txt index 46aefedf60..879563f7af 100644 --- a/docs/command/atlas-integrations-list.txt +++ b/docs/command/atlas-integrations-list.txt @@ -14,6 +14,11 @@ atlas integrations list Return all active third-party integrations for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-integrations.txt b/docs/command/atlas-integrations.txt index 5324838902..92ca1d1af9 100644 --- a/docs/command/atlas-integrations.txt +++ b/docs/command/atlas-integrations.txt @@ -14,6 +14,13 @@ atlas integrations Configure third-party integrations for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations-create.txt b/docs/command/atlas-liveMigrations-create.txt index dbdd664ecd..9f410ab0cc 100644 --- a/docs/command/atlas-liveMigrations-create.txt +++ b/docs/command/atlas-liveMigrations-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations create Create a new push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-cutover.txt b/docs/command/atlas-liveMigrations-cutover.txt index b52d4f9ee8..2876298183 100644 --- a/docs/command/atlas-liveMigrations-cutover.txt +++ b/docs/command/atlas-liveMigrations-cutover.txt @@ -14,6 +14,11 @@ atlas liveMigrations cutover Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-describe.txt b/docs/command/atlas-liveMigrations-describe.txt index 2798a01192..fc5c697263 100644 --- a/docs/command/atlas-liveMigrations-describe.txt +++ b/docs/command/atlas-liveMigrations-describe.txt @@ -14,6 +14,13 @@ atlas liveMigrations describe Return a push live migration job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-liveMigrations-link-create.txt b/docs/command/atlas-liveMigrations-link-create.txt index e736135d52..dfdfb601a2 100644 --- a/docs/command/atlas-liveMigrations-link-create.txt +++ b/docs/command/atlas-liveMigrations-link-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations link create Create a new link-token for a push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-link-delete.txt b/docs/command/atlas-liveMigrations-link-delete.txt index 5b4573824a..e50a4af096 100644 --- a/docs/command/atlas-liveMigrations-link-delete.txt +++ b/docs/command/atlas-liveMigrations-link-delete.txt @@ -14,6 +14,13 @@ atlas liveMigrations link delete Delete one link-token. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-liveMigrations-link.txt b/docs/command/atlas-liveMigrations-link.txt index 7d81d1f085..04ae43d877 100644 --- a/docs/command/atlas-liveMigrations-link.txt +++ b/docs/command/atlas-liveMigrations-link.txt @@ -14,6 +14,13 @@ atlas liveMigrations link Manage the link-token for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations-validation-create.txt b/docs/command/atlas-liveMigrations-validation-create.txt index f47530b581..a427a5309a 100644 --- a/docs/command/atlas-liveMigrations-validation-create.txt +++ b/docs/command/atlas-liveMigrations-validation-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations validation create Create a new validation request for a push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-validation-describe.txt b/docs/command/atlas-liveMigrations-validation-describe.txt index 85cf8225b7..ab5baf9594 100644 --- a/docs/command/atlas-liveMigrations-validation-describe.txt +++ b/docs/command/atlas-liveMigrations-validation-describe.txt @@ -14,6 +14,13 @@ atlas liveMigrations validation describe Return one validation job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-liveMigrations-validation.txt b/docs/command/atlas-liveMigrations-validation.txt index e0e174761c..da2ef7d201 100644 --- a/docs/command/atlas-liveMigrations-validation.txt +++ b/docs/command/atlas-liveMigrations-validation.txt @@ -14,6 +14,13 @@ atlas liveMigrations validation Manage a Live Migration validation job for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations.txt b/docs/command/atlas-liveMigrations.txt index 015e14547d..90effdf80a 100644 --- a/docs/command/atlas-liveMigrations.txt +++ b/docs/command/atlas-liveMigrations.txt @@ -14,6 +14,13 @@ atlas liveMigrations Manage a Live Migration to Atlas for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-logs-download.txt b/docs/command/atlas-logs-download.txt index 576714f0de..30e7b5c91d 100644 --- a/docs/command/atlas-logs-download.txt +++ b/docs/command/atlas-logs-download.txt @@ -14,6 +14,11 @@ atlas logs download Download a compressed file that contains the MongoDB logs for the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command downloads a file with a .gz extension. To find the hostnames for an Atlas project, use the process list command. diff --git a/docs/command/atlas-logs.txt b/docs/command/atlas-logs.txt index 36035a512e..ca910c3c48 100644 --- a/docs/command/atlas-logs.txt +++ b/docs/command/atlas-logs.txt @@ -14,6 +14,13 @@ atlas logs Download host logs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-maintenanceWindows-clear.txt b/docs/command/atlas-maintenanceWindows-clear.txt index 300aafbd30..d268de7152 100644 --- a/docs/command/atlas-maintenanceWindows-clear.txt +++ b/docs/command/atlas-maintenanceWindows-clear.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows clear Clear the current maintenance window setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows-defer.txt b/docs/command/atlas-maintenanceWindows-defer.txt index f586ce1e7e..142f73f6ca 100644 --- a/docs/command/atlas-maintenanceWindows-defer.txt +++ b/docs/command/atlas-maintenanceWindows-defer.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows defer Defer scheduled maintenance for your project for one week. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows-describe.txt b/docs/command/atlas-maintenanceWindows-describe.txt index 2401651d5e..7ab67f4ab9 100644 --- a/docs/command/atlas-maintenanceWindows-describe.txt +++ b/docs/command/atlas-maintenanceWindows-describe.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows describe Return the maintenance window details for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-maintenanceWindows-update.txt b/docs/command/atlas-maintenanceWindows-update.txt index affa97dd2f..afe0e2be08 100644 --- a/docs/command/atlas-maintenanceWindows-update.txt +++ b/docs/command/atlas-maintenanceWindows-update.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows update Modify the maintenance window for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows.txt b/docs/command/atlas-maintenanceWindows.txt index fa4ee9c2d8..d873ba6ecd 100644 --- a/docs/command/atlas-maintenanceWindows.txt +++ b/docs/command/atlas-maintenanceWindows.txt @@ -14,6 +14,13 @@ atlas maintenanceWindows Manage Atlas maintenance windows. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-databases-describe.txt b/docs/command/atlas-metrics-databases-describe.txt index 74def3d321..6d9ca9e037 100644 --- a/docs/command/atlas-metrics-databases-describe.txt +++ b/docs/command/atlas-metrics-databases-describe.txt @@ -14,6 +14,11 @@ atlas metrics databases describe Return the measurements of a database on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas process list diff --git a/docs/command/atlas-metrics-databases-list.txt b/docs/command/atlas-metrics-databases-list.txt index b3cc899445..1be0cf3730 100644 --- a/docs/command/atlas-metrics-databases-list.txt +++ b/docs/command/atlas-metrics-databases-list.txt @@ -14,6 +14,11 @@ atlas metrics databases list Return all databases running on the specified host for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics-databases.txt b/docs/command/atlas-metrics-databases.txt index 2db0e1a894..83f8f80bf4 100644 --- a/docs/command/atlas-metrics-databases.txt +++ b/docs/command/atlas-metrics-databases.txt @@ -14,6 +14,13 @@ atlas metrics databases List available databases or database metrics for a given host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-disks-describe.txt b/docs/command/atlas-metrics-disks-describe.txt index 3e20344122..2948833c71 100644 --- a/docs/command/atlas-metrics-disks-describe.txt +++ b/docs/command/atlas-metrics-disks-describe.txt @@ -14,6 +14,11 @@ atlas metrics disks describe Return the measurements of a disk or partition on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics-disks-list.txt b/docs/command/atlas-metrics-disks-list.txt index d541f41a04..86436a8b14 100644 --- a/docs/command/atlas-metrics-disks-list.txt +++ b/docs/command/atlas-metrics-disks-list.txt @@ -14,6 +14,11 @@ atlas metrics disks list Return all disks or disk partitions on the specified host for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run: $ atlas processes list diff --git a/docs/command/atlas-metrics-disks.txt b/docs/command/atlas-metrics-disks.txt index 42bd8f2120..2c0651ea72 100644 --- a/docs/command/atlas-metrics-disks.txt +++ b/docs/command/atlas-metrics-disks.txt @@ -14,6 +14,13 @@ atlas metrics disks List available disks or disk metrics for a given host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-processes.txt b/docs/command/atlas-metrics-processes.txt index 9ee270bb13..6852b579cf 100644 --- a/docs/command/atlas-metrics-processes.txt +++ b/docs/command/atlas-metrics-processes.txt @@ -14,6 +14,11 @@ atlas metrics processes Return the process measurements for the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics.txt b/docs/command/atlas-metrics.txt index a1c5aadc66..dad08d1cd5 100644 --- a/docs/command/atlas-metrics.txt +++ b/docs/command/atlas-metrics.txt @@ -14,6 +14,13 @@ atlas metrics Get metrics on the MongoDB process. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-networking-containers-delete.txt b/docs/command/atlas-networking-containers-delete.txt index 689524ce53..0eff902b03 100644 --- a/docs/command/atlas-networking-containers-delete.txt +++ b/docs/command/atlas-networking-containers-delete.txt @@ -14,6 +14,11 @@ atlas networking containers delete Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-networking-containers-list.txt b/docs/command/atlas-networking-containers-list.txt index a8750b67d6..26ea59bb09 100644 --- a/docs/command/atlas-networking-containers-list.txt +++ b/docs/command/atlas-networking-containers-list.txt @@ -14,6 +14,11 @@ atlas networking containers list Return all network peering containers for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-networking-containers.txt b/docs/command/atlas-networking-containers.txt index 6756369132..de3d5bd384 100644 --- a/docs/command/atlas-networking-containers.txt +++ b/docs/command/atlas-networking-containers.txt @@ -14,6 +14,13 @@ atlas networking containers Manage Network Peering containers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-networking-peering-create-aws.txt b/docs/command/atlas-networking-peering-create-aws.txt index 111a3de4cc..9190d9e722 100644 --- a/docs/command/atlas-networking-peering-create-aws.txt +++ b/docs/command/atlas-networking-peering-create-aws.txt @@ -14,6 +14,11 @@ atlas networking peering create aws Create a network peering connection between the Atlas VPC and your AWS VPC. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/docs/command/atlas-networking-peering-create-azure.txt b/docs/command/atlas-networking-peering-create-azure.txt index 714d7b51a0..6376ab7a2b 100644 --- a/docs/command/atlas-networking-peering-create-azure.txt +++ b/docs/command/atlas-networking-peering-create-azure.txt @@ -14,6 +14,11 @@ atlas networking peering create azure Create a network peering connection between the Atlas VPC and your Azure VNet. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. diff --git a/docs/command/atlas-networking-peering-create-gcp.txt b/docs/command/atlas-networking-peering-create-gcp.txt index 6110e4fcd2..e8428e69db 100644 --- a/docs/command/atlas-networking-peering-create-gcp.txt +++ b/docs/command/atlas-networking-peering-create-gcp.txt @@ -14,6 +14,11 @@ atlas networking peering create gcp Create a network peering connection between the Atlas VPC and your Google Cloud VPC. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/docs/command/atlas-networking-peering-create.txt b/docs/command/atlas-networking-peering-create.txt index fbe947b7b4..95c2a81eee 100644 --- a/docs/command/atlas-networking-peering-create.txt +++ b/docs/command/atlas-networking-peering-create.txt @@ -14,6 +14,13 @@ atlas networking peering create Create a connection with AWS, Azure and Google Cloud. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-networking-peering-delete.txt b/docs/command/atlas-networking-peering-delete.txt index ec44e2d033..44a6c65e4f 100644 --- a/docs/command/atlas-networking-peering-delete.txt +++ b/docs/command/atlas-networking-peering-delete.txt @@ -14,6 +14,11 @@ atlas networking peering delete Remove the specified peering connection from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-networking-peering-list.txt b/docs/command/atlas-networking-peering-list.txt index e47c6e0848..97fa456c28 100644 --- a/docs/command/atlas-networking-peering-list.txt +++ b/docs/command/atlas-networking-peering-list.txt @@ -14,6 +14,11 @@ atlas networking peering list Return the details for all network peering connections for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-networking-peering-watch.txt b/docs/command/atlas-networking-peering-watch.txt index 7c8e3ec7af..25b55ff492 100644 --- a/docs/command/atlas-networking-peering-watch.txt +++ b/docs/command/atlas-networking-peering-watch.txt @@ -14,6 +14,11 @@ atlas networking peering watch Watch the specified peering connection in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the peering connection's status periodically until it becomes available. Once it reaches the expected state, the command prints "Network peering changes completed." If you run the command in the terminal, it blocks the terminal session until the resource is available. diff --git a/docs/command/atlas-networking-peering.txt b/docs/command/atlas-networking-peering.txt index fdeb3a8f5f..687e0a1cf5 100644 --- a/docs/command/atlas-networking-peering.txt +++ b/docs/command/atlas-networking-peering.txt @@ -14,6 +14,13 @@ atlas networking peering Manage Network Peering connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-networking.txt b/docs/command/atlas-networking.txt index e98acb29b2..6ee3e6788c 100644 --- a/docs/command/atlas-networking.txt +++ b/docs/command/atlas-networking.txt @@ -14,6 +14,13 @@ atlas networking Manage or configure network peering for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt index 7ba279eced..a039b3524c 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists create Create an IP access list entry for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the apiKey option, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt index 76735790d6..5a81d55149 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists delete Remove the specified IP access list entry from your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Read Write role. Syntax diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt index b18ee729a7..d255724bb9 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists list Return all IP access list entries for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-organizations-apiKeys-accessLists.txt b/docs/command/atlas-organizations-apiKeys-accessLists.txt index 93b1ff2009..e7d543fdf9 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys accessLists Manage the IP access list for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-apiKeys-assign.txt b/docs/command/atlas-organizations-apiKeys-assign.txt index 9842e8951a..554977aaf8 100644 --- a/docs/command/atlas-organizations-apiKeys-assign.txt +++ b/docs/command/atlas-organizations-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys assign Modify the roles or description for the specified organization API key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-organizations-apiKeys-create.txt b/docs/command/atlas-organizations-apiKeys-create.txt index c285d2e91c..31883a7189 100644 --- a/docs/command/atlas-organizations-apiKeys-create.txt +++ b/docs/command/atlas-organizations-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys create Create an API Key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-organizations-apiKeys-delete.txt b/docs/command/atlas-organizations-apiKeys-delete.txt index 37edd780fe..f3595e7fb2 100644 --- a/docs/command/atlas-organizations-apiKeys-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-delete.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys delete Remove the specified API key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-organizations-apiKeys-describe.txt b/docs/command/atlas-organizations-apiKeys-describe.txt index 19b24d2cd3..ab7980d2ee 100644 --- a/docs/command/atlas-organizations-apiKeys-describe.txt +++ b/docs/command/atlas-organizations-apiKeys-describe.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys describe Return the details for the specified API key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-organizations-apiKeys-list.txt b/docs/command/atlas-organizations-apiKeys-list.txt index 5c6d5e5410..e812666638 100644 --- a/docs/command/atlas-organizations-apiKeys-list.txt +++ b/docs/command/atlas-organizations-apiKeys-list.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys list Return all API keys for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-apiKeys.txt b/docs/command/atlas-organizations-apiKeys.txt index d4af319a1e..be40b45439 100644 --- a/docs/command/atlas-organizations-apiKeys.txt +++ b/docs/command/atlas-organizations-apiKeys.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys Organization API Keys operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-create.txt b/docs/command/atlas-organizations-create.txt index e9fc7d21c3..0d798f85c2 100644 --- a/docs/command/atlas-organizations-create.txt +++ b/docs/command/atlas-organizations-create.txt @@ -14,6 +14,11 @@ atlas organizations create Create an organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. Syntax diff --git a/docs/command/atlas-organizations-delete.txt b/docs/command/atlas-organizations-delete.txt index 1f6a6afc13..3fe1adae7a 100644 --- a/docs/command/atlas-organizations-delete.txt +++ b/docs/command/atlas-organizations-delete.txt @@ -14,6 +14,11 @@ atlas organizations delete Remove the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Organizations with active projects can't be removed. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/docs/command/atlas-organizations-describe.txt b/docs/command/atlas-organizations-describe.txt index 52b0e108ea..722ee41300 100644 --- a/docs/command/atlas-organizations-describe.txt +++ b/docs/command/atlas-organizations-describe.txt @@ -14,6 +14,11 @@ atlas organizations describe Return the details for the specified organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-invitations-delete.txt b/docs/command/atlas-organizations-invitations-delete.txt index ebd795ec8b..934847c776 100644 --- a/docs/command/atlas-organizations-invitations-delete.txt +++ b/docs/command/atlas-organizations-invitations-delete.txt @@ -14,6 +14,11 @@ atlas organizations invitations delete Remove the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-describe.txt b/docs/command/atlas-organizations-invitations-describe.txt index c842a75fb8..f261f57b55 100644 --- a/docs/command/atlas-organizations-invitations-describe.txt +++ b/docs/command/atlas-organizations-invitations-describe.txt @@ -14,6 +14,11 @@ atlas organizations invitations describe Return the details for the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-invite.txt b/docs/command/atlas-organizations-invitations-invite.txt index d62a0a92f9..34a17c3d61 100644 --- a/docs/command/atlas-organizations-invitations-invite.txt +++ b/docs/command/atlas-organizations-invitations-invite.txt @@ -14,6 +14,11 @@ atlas organizations invitations invite Invite the specified MongoDB user to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-list.txt b/docs/command/atlas-organizations-invitations-list.txt index 074015dd98..4f48a09255 100644 --- a/docs/command/atlas-organizations-invitations-list.txt +++ b/docs/command/atlas-organizations-invitations-list.txt @@ -14,6 +14,11 @@ atlas organizations invitations list Return all pending invitations to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-update.txt b/docs/command/atlas-organizations-invitations-update.txt index 446dcf4ff0..74e04f0250 100644 --- a/docs/command/atlas-organizations-invitations-update.txt +++ b/docs/command/atlas-organizations-invitations-update.txt @@ -14,6 +14,11 @@ atlas organizations invitations update Modifies the details of the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can use either the invitation ID or the user's email address to specify the invitation. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/docs/command/atlas-organizations-invitations.txt b/docs/command/atlas-organizations-invitations.txt index 0135c98693..c0e1dfe05a 100644 --- a/docs/command/atlas-organizations-invitations.txt +++ b/docs/command/atlas-organizations-invitations.txt @@ -14,6 +14,11 @@ atlas organizations invitations Invitation operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB organization invites. Options diff --git a/docs/command/atlas-organizations-list.txt b/docs/command/atlas-organizations-list.txt index 5248147670..76f481fe96 100644 --- a/docs/command/atlas-organizations-list.txt +++ b/docs/command/atlas-organizations-list.txt @@ -14,6 +14,11 @@ atlas organizations list Return all organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-users-list.txt b/docs/command/atlas-organizations-users-list.txt index 94299faa64..2cc14d066f 100644 --- a/docs/command/atlas-organizations-users-list.txt +++ b/docs/command/atlas-organizations-users-list.txt @@ -14,6 +14,11 @@ atlas organizations users list Return all users for an organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-users.txt b/docs/command/atlas-organizations-users.txt index 928a8825e1..e0319afe16 100644 --- a/docs/command/atlas-organizations-users.txt +++ b/docs/command/atlas-organizations-users.txt @@ -14,6 +14,13 @@ atlas organizations users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-organizations.txt b/docs/command/atlas-organizations.txt index fa2ee1e599..b6c694c2fb 100644 --- a/docs/command/atlas-organizations.txt +++ b/docs/command/atlas-organizations.txt @@ -14,6 +14,11 @@ atlas organizations Manage your Atlas organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB organizations. Options diff --git a/docs/command/atlas-performanceAdvisor-namespaces-list.txt b/docs/command/atlas-performanceAdvisor-namespaces-list.txt index 19b5659d0d..ec9bb3ac8e 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces-list.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor namespaces list Return up to 20 namespaces for collections experiencing slow queries on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Namespaces appear in the following format: {database}.{collection}. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/docs/command/atlas-performanceAdvisor-namespaces.txt b/docs/command/atlas-performanceAdvisor-namespaces.txt index e05970fbc6..34190e7c8d 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor namespaces Retrieve namespaces for collections experiencing slow queries +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt index 09b64bb4cf..92f48a8714 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold disable Disable the application-managed slow operation threshold for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt index c47613c480..5b7d9adf3d 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold enable Enable the application-managed slow operation threshold for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application 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. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt index a5ad1e3e3e..dfb91ea603 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor slowOperationThreshold Enable or disable management of the slow operation threshold for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt index 52ad8c405e..a8bd30ec0d 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowQueryLogs list Return log lines for slow queries that the Performance Advisor and Query Profiler identified. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt index 55a1fb2c0d..ba09f494d5 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor slowQueryLogs Get log lines for slow queries for a specified host +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt index bcf0b527fd..e022efb786 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor suggestedIndexes list Return the suggested indexes for collections experiencing slow queries. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt index b765cf2ebd..76a3635b45 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor suggestedIndexes Get suggested indexes for collections experiencing slow queries +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor.txt b/docs/command/atlas-performanceAdvisor.txt index 4428b2f1ea..7549addd09 100644 --- a/docs/command/atlas-performanceAdvisor.txt +++ b/docs/command/atlas-performanceAdvisor.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor Learn more about slow queries and get suggestions to improve database performance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-plugin-install.txt b/docs/command/atlas-plugin-install.txt index fa57e08fbc..507ada6b59 100644 --- a/docs/command/atlas-plugin-install.txt +++ b/docs/command/atlas-plugin-install.txt @@ -14,6 +14,11 @@ atlas plugin install Install Atlas CLI plugin from a GitHub repository. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Install an Atlas CLI plugin from a GitHub repository. You can specify a GitHub repository using either the "/" format or a full URL. When you install the plugin, its latest release on GitHub is used by default. diff --git a/docs/command/atlas-plugin-list.txt b/docs/command/atlas-plugin-list.txt index eced103a63..15389bf918 100644 --- a/docs/command/atlas-plugin-list.txt +++ b/docs/command/atlas-plugin-list.txt @@ -14,6 +14,13 @@ atlas plugin list Returns a list of all installed plugins. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-plugin-uninstall.txt b/docs/command/atlas-plugin-uninstall.txt index 6117d6b567..4bd502c1fc 100644 --- a/docs/command/atlas-plugin-uninstall.txt +++ b/docs/command/atlas-plugin-uninstall.txt @@ -14,6 +14,11 @@ atlas plugin uninstall Uninstall Atlas CLI plugin. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Uninstall an Atlas CLI plugin. You can specify a plugin to uninstall using either the "/" format or the plugin name. diff --git a/docs/command/atlas-plugin-update.txt b/docs/command/atlas-plugin-update.txt index e91b656145..2c836adde9 100644 --- a/docs/command/atlas-plugin-update.txt +++ b/docs/command/atlas-plugin-update.txt @@ -14,6 +14,11 @@ atlas plugin update Update Atlas CLI plugin. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Update an Atlas CLI plugin. You can specify a plugin to update using either the "/" format or the plugin name. Additionally, you can use the "--all" flag to update all plugins. diff --git a/docs/command/atlas-plugin.txt b/docs/command/atlas-plugin.txt index c3c489f453..cde9a89012 100644 --- a/docs/command/atlas-plugin.txt +++ b/docs/command/atlas-plugin.txt @@ -14,6 +14,13 @@ atlas plugin Manage plugins for the AtlasCLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-aws-create.txt b/docs/command/atlas-privateEndpoints-aws-create.txt index 3dc0a82304..dc8508e098 100644 --- a/docs/command/atlas-privateEndpoints-aws-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws create Create a new AWS private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-aws-delete.txt b/docs/command/atlas-privateEndpoints-aws-delete.txt index 99afb3ecc3..eb5e8b8224 100644 --- a/docs/command/atlas-privateEndpoints-aws-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws delete Remove the specified AWS private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-describe.txt b/docs/command/atlas-privateEndpoints-aws-describe.txt index 73d6bc46c0..9817400dcd 100644 --- a/docs/command/atlas-privateEndpoints-aws-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws describe Return the details for the specified AWS private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt index fcaeafe85a..02ca7211fb 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces create Create a new interface for the specified AWS private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt index 11f4b27f9e..c68c1aa2a4 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces delete Remove the specified AWS private endpoint interface and related service from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt index 4c42cf4c27..48c3251044 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces describe Return the details for the specified AWS private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces.txt b/docs/command/atlas-privateEndpoints-aws-interfaces.txt index eefb55825a..8f34b38118 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws interfaces Manage Atlas AWS private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-aws-list.txt b/docs/command/atlas-privateEndpoints-aws-list.txt index d73ffa7d70..bb582ae1bb 100644 --- a/docs/command/atlas-privateEndpoints-aws-list.txt +++ b/docs/command/atlas-privateEndpoints-aws-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws list Return all AWS private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-watch.txt b/docs/command/atlas-privateEndpoints-aws-watch.txt index 2882272d4d..c033fc5d11 100644 --- a/docs/command/atlas-privateEndpoints-aws-watch.txt +++ b/docs/command/atlas-privateEndpoints-aws-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws watch Watch the specified AWS private endpoint in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-aws.txt b/docs/command/atlas-privateEndpoints-aws.txt index d761c7a4ed..9660c5efee 100644 --- a/docs/command/atlas-privateEndpoints-aws.txt +++ b/docs/command/atlas-privateEndpoints-aws.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws Manage AWS Private Endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-azure-create.txt b/docs/command/atlas-privateEndpoints-azure-create.txt index 70c1bb7a91..2e6073982e 100644 --- a/docs/command/atlas-privateEndpoints-azure-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure create Create a new Azure private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-azure-delete.txt b/docs/command/atlas-privateEndpoints-azure-delete.txt index d450ade535..868f482387 100644 --- a/docs/command/atlas-privateEndpoints-azure-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure delete Remove the specified Azure private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-describe.txt b/docs/command/atlas-privateEndpoints-azure-describe.txt index 08ea40362d..2c0d1076fa 100644 --- a/docs/command/atlas-privateEndpoints-azure-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure describe Return the details for the specified Azure private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt index 78aaaa4164..c497a4163a 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces create Create a new interface for the specified Azure private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt index f09ff091c7..151746a489 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces delete Remove the specified Azure private endpoint interface and related service from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt index bd17506aa5..ff5cfdfb77 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces describe Return the details for the specified Azure private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces.txt b/docs/command/atlas-privateEndpoints-azure-interfaces.txt index 937d2aacae..952c255d3a 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure interfaces Manage Atlas Azure private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-azure-list.txt b/docs/command/atlas-privateEndpoints-azure-list.txt index 3564976b5a..096d98ab5d 100644 --- a/docs/command/atlas-privateEndpoints-azure-list.txt +++ b/docs/command/atlas-privateEndpoints-azure-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure list Return all Azure private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-watch.txt b/docs/command/atlas-privateEndpoints-azure-watch.txt index fa8ad3dec8..e0005181fe 100644 --- a/docs/command/atlas-privateEndpoints-azure-watch.txt +++ b/docs/command/atlas-privateEndpoints-azure-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure watch Watch the specified Azure private endpoint in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-azure.txt b/docs/command/atlas-privateEndpoints-azure.txt index 23b7368dd2..e73eb1180f 100644 --- a/docs/command/atlas-privateEndpoints-azure.txt +++ b/docs/command/atlas-privateEndpoints-azure.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure Manage Azure Private Endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-gcp-create.txt b/docs/command/atlas-privateEndpoints-gcp-create.txt index 9da00080e5..5aa8f02709 100644 --- a/docs/command/atlas-privateEndpoints-gcp-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp create Create a new GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-delete.txt b/docs/command/atlas-privateEndpoints-gcp-delete.txt index a9f0a42728..6500572f82 100644 --- a/docs/command/atlas-privateEndpoints-gcp-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp delete Delete a GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-describe.txt b/docs/command/atlas-privateEndpoints-gcp-describe.txt index aa00926e04..a699afa0b0 100644 --- a/docs/command/atlas-privateEndpoints-gcp-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp describe Return a specific GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt index c88a72796d..9d2f76941d 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces create Create a GCP private endpoint interface. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt index f9513ead7f..a91ae03d8d 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces delete Delete a specific GCP private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt index db04731d9a..a938051cb9 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces describe Return a specific GCP private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt index ec3ec345fc..828182a74b 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp interfaces Manage Atlas GCP private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-gcp-list.txt b/docs/command/atlas-privateEndpoints-gcp-list.txt index 26f48fd754..bb887d3c57 100644 --- a/docs/command/atlas-privateEndpoints-gcp-list.txt +++ b/docs/command/atlas-privateEndpoints-gcp-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp list List GCP private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-watch.txt b/docs/command/atlas-privateEndpoints-gcp-watch.txt index 5741d695f6..1fbb0b800a 100644 --- a/docs/command/atlas-privateEndpoints-gcp-watch.txt +++ b/docs/command/atlas-privateEndpoints-gcp-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp watch Watch the specified GCP private endpoint to detect changes in the endpoint's state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-gcp.txt b/docs/command/atlas-privateEndpoints-gcp.txt index 29405adf0f..5f4d56f2eb 100644 --- a/docs/command/atlas-privateEndpoints-gcp.txt +++ b/docs/command/atlas-privateEndpoints-gcp.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp Manage GCP private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt index f378aad693..be827fafd9 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes describe Return the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Use this command to check whether you can create multiple private resources per region. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt index 22b38a3e8b..0b0f0f65ef 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes disable Disable the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This disables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt index e7caddbbe0..667c08260c 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes enable Enable the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This enables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes.txt b/docs/command/atlas-privateEndpoints-regionalModes.txt index 87c8064d9b..1314cd50c3 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes.txt @@ -14,6 +14,13 @@ atlas privateEndpoints regionalModes Manage regionalized private endpoint setting for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints.txt b/docs/command/atlas-privateEndpoints.txt index 8a05ab2145..86ac946ac6 100644 --- a/docs/command/atlas-privateEndpoints.txt +++ b/docs/command/atlas-privateEndpoints.txt @@ -14,6 +14,13 @@ atlas privateEndpoints Manage Atlas private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-processes-describe.txt b/docs/command/atlas-processes-describe.txt index d96733b374..064264d664 100644 --- a/docs/command/atlas-processes-describe.txt +++ b/docs/command/atlas-processes-describe.txt @@ -14,6 +14,13 @@ atlas processes describe Return the details for the specified MongoDB process for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-processes-list.txt b/docs/command/atlas-processes-list.txt index 6f575dfbeb..c488e2fcd6 100644 --- a/docs/command/atlas-processes-list.txt +++ b/docs/command/atlas-processes-list.txt @@ -14,6 +14,11 @@ atlas processes list Return all MongoDB processes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-processes.txt b/docs/command/atlas-processes.txt index 5fd7e81a35..866cb046f2 100644 --- a/docs/command/atlas-processes.txt +++ b/docs/command/atlas-processes.txt @@ -14,6 +14,13 @@ atlas processes Manage MongoDB processes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-projects-apiKeys-assign.txt b/docs/command/atlas-projects-apiKeys-assign.txt index e08d747ceb..c4fff0074a 100644 --- a/docs/command/atlas-projects-apiKeys-assign.txt +++ b/docs/command/atlas-projects-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas projects apiKeys assign Assign the specified organization API key to your project and modify the API key's roles for the project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-projects-apiKeys-create.txt b/docs/command/atlas-projects-apiKeys-create.txt index 78b06bbe97..91312ddc8a 100644 --- a/docs/command/atlas-projects-apiKeys-create.txt +++ b/docs/command/atlas-projects-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas projects apiKeys create Create an organization API key and assign it to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. If you don't provide an organization level role, the API Key defaults to organization member of the project parent organization. diff --git a/docs/command/atlas-projects-apiKeys-delete.txt b/docs/command/atlas-projects-apiKeys-delete.txt index c2b2fbc72c..7501f8b555 100644 --- a/docs/command/atlas-projects-apiKeys-delete.txt +++ b/docs/command/atlas-projects-apiKeys-delete.txt @@ -14,6 +14,11 @@ atlas projects apiKeys delete Remove the specified organization API key from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-projects-apiKeys-list.txt b/docs/command/atlas-projects-apiKeys-list.txt index 4f26094679..41e8846d06 100644 --- a/docs/command/atlas-projects-apiKeys-list.txt +++ b/docs/command/atlas-projects-apiKeys-list.txt @@ -14,6 +14,11 @@ atlas projects apiKeys list Return all organization API keys assigned to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/docs/command/atlas-projects-apiKeys.txt b/docs/command/atlas-projects-apiKeys.txt index aa4c4c61da..ba84de54e3 100644 --- a/docs/command/atlas-projects-apiKeys.txt +++ b/docs/command/atlas-projects-apiKeys.txt @@ -14,6 +14,13 @@ atlas projects apiKeys Manage API Keys for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-projects-create.txt b/docs/command/atlas-projects-create.txt index 2fa91868b6..f7dffbe5aa 100644 --- a/docs/command/atlas-projects-create.txt +++ b/docs/command/atlas-projects-create.txt @@ -14,6 +14,11 @@ atlas projects create Create a project in your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. diff --git a/docs/command/atlas-projects-delete.txt b/docs/command/atlas-projects-delete.txt index 840a40a2fa..1d2aaad0e1 100644 --- a/docs/command/atlas-projects-delete.txt +++ b/docs/command/atlas-projects-delete.txt @@ -14,6 +14,11 @@ atlas projects delete Remove the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-projects-describe.txt b/docs/command/atlas-projects-describe.txt index 2d32ee6d1b..02dbf663d3 100644 --- a/docs/command/atlas-projects-describe.txt +++ b/docs/command/atlas-projects-describe.txt @@ -14,6 +14,11 @@ atlas projects describe Return the details for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-list.txt b/docs/command/atlas-projects-list.txt index d34deeb096..1993d5de06 100644 --- a/docs/command/atlas-projects-list.txt +++ b/docs/command/atlas-projects-list.txt @@ -14,6 +14,11 @@ atlas projects list Return all projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-projects-settings-describe.txt b/docs/command/atlas-projects-settings-describe.txt index a69830c3d1..01b89daaec 100644 --- a/docs/command/atlas-projects-settings-describe.txt +++ b/docs/command/atlas-projects-settings-describe.txt @@ -14,6 +14,13 @@ atlas projects settings describe Retrieve details for settings to the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-projects-settings-update.txt b/docs/command/atlas-projects-settings-update.txt index 3a8fe62e87..b2351b4304 100644 --- a/docs/command/atlas-projects-settings-update.txt +++ b/docs/command/atlas-projects-settings-update.txt @@ -14,6 +14,13 @@ atlas projects settings update Updates settings for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/docs/command/atlas-projects-settings.txt b/docs/command/atlas-projects-settings.txt index 8671663757..6ba1110600 100644 --- a/docs/command/atlas-projects-settings.txt +++ b/docs/command/atlas-projects-settings.txt @@ -14,6 +14,11 @@ atlas projects settings Settings operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Manage your project settings. Options diff --git a/docs/command/atlas-projects-teams-add.txt b/docs/command/atlas-projects-teams-add.txt index f8670378f0..7194a8c4e8 100644 --- a/docs/command/atlas-projects-teams-add.txt +++ b/docs/command/atlas-projects-teams-add.txt @@ -14,6 +14,11 @@ atlas projects teams add Add the specified team to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + All members of the team share the same project access. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-projects-teams-delete.txt b/docs/command/atlas-projects-teams-delete.txt index 1f5819a10d..1f10432b61 100644 --- a/docs/command/atlas-projects-teams-delete.txt +++ b/docs/command/atlas-projects-teams-delete.txt @@ -14,6 +14,11 @@ atlas projects teams delete Remove the specified team from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you remove a team from your project, the team still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/docs/command/atlas-projects-teams-list.txt b/docs/command/atlas-projects-teams-list.txt index 12e530a794..8bd4385f22 100644 --- a/docs/command/atlas-projects-teams-list.txt +++ b/docs/command/atlas-projects-teams-list.txt @@ -14,6 +14,11 @@ atlas projects teams list Return all teams for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-teams-update.txt b/docs/command/atlas-projects-teams-update.txt index 02527e0e2e..5090822fbc 100644 --- a/docs/command/atlas-projects-teams-update.txt +++ b/docs/command/atlas-projects-teams-update.txt @@ -14,6 +14,11 @@ atlas projects teams update Modify the roles for the specified team for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/docs/command/atlas-projects-teams.txt b/docs/command/atlas-projects-teams.txt index b215be2184..7b11e7f1c9 100644 --- a/docs/command/atlas-projects-teams.txt +++ b/docs/command/atlas-projects-teams.txt @@ -14,6 +14,13 @@ atlas projects teams Manage your Atlas teams. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-projects-update.txt b/docs/command/atlas-projects-update.txt index 3c037c1528..8c2d7cc102 100644 --- a/docs/command/atlas-projects-update.txt +++ b/docs/command/atlas-projects-update.txt @@ -14,6 +14,11 @@ atlas projects update Update a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-projects-users-delete.txt b/docs/command/atlas-projects-users-delete.txt index 870543b4f6..873b0416eb 100644 --- a/docs/command/atlas-projects-users-delete.txt +++ b/docs/command/atlas-projects-users-delete.txt @@ -14,6 +14,11 @@ atlas projects users delete Remove the specified user from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you remove a user from your project, the user still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/docs/command/atlas-projects-users-list.txt b/docs/command/atlas-projects-users-list.txt index fda0542dcb..fadf573f78 100644 --- a/docs/command/atlas-projects-users-list.txt +++ b/docs/command/atlas-projects-users-list.txt @@ -14,6 +14,11 @@ atlas projects users list Return all users for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-users.txt b/docs/command/atlas-projects-users.txt index 0292d11497..072ab816c9 100644 --- a/docs/command/atlas-projects-users.txt +++ b/docs/command/atlas-projects-users.txt @@ -14,6 +14,13 @@ atlas projects users Manage users for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-projects.txt b/docs/command/atlas-projects.txt index b7e5825090..c7ea4e8304 100644 --- a/docs/command/atlas-projects.txt +++ b/docs/command/atlas-projects.txt @@ -14,6 +14,11 @@ atlas projects Manage your Atlas projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB projects. Options diff --git a/docs/command/atlas-security-customerCerts-create.txt b/docs/command/atlas-security-customerCerts-create.txt index f22030f134..5d573b29f4 100644 --- a/docs/command/atlas-security-customerCerts-create.txt +++ b/docs/command/atlas-security-customerCerts-create.txt @@ -14,6 +14,11 @@ atlas security customerCerts create Saves a customer-managed X.509 configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Saving a customer-managed X.509 configuration triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-security-customerCerts-describe.txt b/docs/command/atlas-security-customerCerts-describe.txt index c94b4cad31..73c488a5a0 100644 --- a/docs/command/atlas-security-customerCerts-describe.txt +++ b/docs/command/atlas-security-customerCerts-describe.txt @@ -14,6 +14,11 @@ atlas security customerCerts describe Return the details for the current customer-managed X.509 configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-customerCerts-disable.txt b/docs/command/atlas-security-customerCerts-disable.txt index c45f4712e1..53f2727ac5 100644 --- a/docs/command/atlas-security-customerCerts-disable.txt +++ b/docs/command/atlas-security-customerCerts-disable.txt @@ -14,6 +14,11 @@ atlas security customerCerts disable Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Disabling customer-managed X.509 triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-security-customerCerts.txt b/docs/command/atlas-security-customerCerts.txt index 9b8a81fb98..f99bba7e9c 100644 --- a/docs/command/atlas-security-customerCerts.txt +++ b/docs/command/atlas-security-customerCerts.txt @@ -14,6 +14,13 @@ atlas security customerCerts Manage customer x509 certificates for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-security-ldap-delete.txt b/docs/command/atlas-security-ldap-delete.txt index 1a26083803..4fb081bec3 100644 --- a/docs/command/atlas-security-ldap-delete.txt +++ b/docs/command/atlas-security-ldap-delete.txt @@ -14,6 +14,11 @@ atlas security ldap delete Remove the current LDAP configuration captured in the userToDNMapping document from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-get.txt b/docs/command/atlas-security-ldap-get.txt index 359a0931fc..faef6899dd 100644 --- a/docs/command/atlas-security-ldap-get.txt +++ b/docs/command/atlas-security-ldap-get.txt @@ -14,6 +14,11 @@ atlas security ldap get Return the current LDAP configuration details for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-save.txt b/docs/command/atlas-security-ldap-save.txt index 8bae744bc4..ebc5e6ac4e 100644 --- a/docs/command/atlas-security-ldap-save.txt +++ b/docs/command/atlas-security-ldap-save.txt @@ -14,6 +14,11 @@ atlas security ldap save Save an LDAP configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-verify-status-watch.txt b/docs/command/atlas-security-ldap-verify-status-watch.txt index 8a13c69d21..3e5781742c 100644 --- a/docs/command/atlas-security-ldap-verify-status-watch.txt +++ b/docs/command/atlas-security-ldap-verify-status-watch.txt @@ -14,6 +14,11 @@ atlas security ldap verify status watch Watch for an LDAP configuration request to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. diff --git a/docs/command/atlas-security-ldap-verify-status.txt b/docs/command/atlas-security-ldap-verify-status.txt index 3458531de3..b419753a15 100644 --- a/docs/command/atlas-security-ldap-verify-status.txt +++ b/docs/command/atlas-security-ldap-verify-status.txt @@ -14,6 +14,11 @@ atlas security ldap verify status Get the status of an LDAP configuration request. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-verify.txt b/docs/command/atlas-security-ldap-verify.txt index 1a76e01654..2ec1b45b5c 100644 --- a/docs/command/atlas-security-ldap-verify.txt +++ b/docs/command/atlas-security-ldap-verify.txt @@ -14,6 +14,11 @@ atlas security ldap verify Request verification of an LDAP configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap.txt b/docs/command/atlas-security-ldap.txt index 20627d1405..ff9c4b1cce 100644 --- a/docs/command/atlas-security-ldap.txt +++ b/docs/command/atlas-security-ldap.txt @@ -14,6 +14,13 @@ atlas security ldap LDAP operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-security.txt b/docs/command/atlas-security.txt index 3457b5871d..da1144d779 100644 --- a/docs/command/atlas-security.txt +++ b/docs/command/atlas-security.txt @@ -14,6 +14,13 @@ atlas security Manage security configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/docs/command/atlas-setup.txt b/docs/command/atlas-setup.txt index f22446e870..4b19fc3a39 100644 --- a/docs/command/atlas-setup.txt +++ b/docs/command/atlas-setup.txt @@ -14,6 +14,11 @@ atlas setup Register, authenticate, create, and access an Atlas cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. Syntax diff --git a/docs/command/atlas-streams-connections-create.txt b/docs/command/atlas-streams-connections-create.txt index 41218f319d..853805c5be 100644 --- a/docs/command/atlas-streams-connections-create.txt +++ b/docs/command/atlas-streams-connections-create.txt @@ -14,6 +14,11 @@ atlas streams connections create Creates a connection for an Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections-delete.txt b/docs/command/atlas-streams-connections-delete.txt index 28a82a8881..7ad329f386 100644 --- a/docs/command/atlas-streams-connections-delete.txt +++ b/docs/command/atlas-streams-connections-delete.txt @@ -14,6 +14,11 @@ atlas streams connections delete Remove the specified Atlas Stream Processing connection from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-streams-connections-describe.txt b/docs/command/atlas-streams-connections-describe.txt index 9c0081ac67..3aa0a5b750 100644 --- a/docs/command/atlas-streams-connections-describe.txt +++ b/docs/command/atlas-streams-connections-describe.txt @@ -14,6 +14,11 @@ atlas streams connections describe Return the details for the specified Atlas Stream Processing connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections-list.txt b/docs/command/atlas-streams-connections-list.txt index 3acd0d2a5d..41ee6fc3ae 100644 --- a/docs/command/atlas-streams-connections-list.txt +++ b/docs/command/atlas-streams-connections-list.txt @@ -14,6 +14,11 @@ atlas streams connections list Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-connections-update.txt b/docs/command/atlas-streams-connections-update.txt index 12c4c249b7..ecd625b87c 100644 --- a/docs/command/atlas-streams-connections-update.txt +++ b/docs/command/atlas-streams-connections-update.txt @@ -14,6 +14,11 @@ atlas streams connections update Modify the details of the specified connection within your Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections.txt b/docs/command/atlas-streams-connections.txt index 2c40745051..cd3cafa2c5 100644 --- a/docs/command/atlas-streams-connections.txt +++ b/docs/command/atlas-streams-connections.txt @@ -14,6 +14,11 @@ atlas streams connections Manage Atlas Stream Processing connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list, update and delete your Atlas Stream Processing connections Options diff --git a/docs/command/atlas-streams-instances-create.txt b/docs/command/atlas-streams-instances-create.txt index 7b3f705da8..e1f3b620fb 100644 --- a/docs/command/atlas-streams-instances-create.txt +++ b/docs/command/atlas-streams-instances-create.txt @@ -14,6 +14,11 @@ atlas streams instances create Create an Atlas Stream Processing instance for your project +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-instances-delete.txt b/docs/command/atlas-streams-instances-delete.txt index f7e1a66ae8..940cf5bbfb 100644 --- a/docs/command/atlas-streams-instances-delete.txt +++ b/docs/command/atlas-streams-instances-delete.txt @@ -14,6 +14,11 @@ atlas streams instances delete Delete an Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. diff --git a/docs/command/atlas-streams-instances-describe.txt b/docs/command/atlas-streams-instances-describe.txt index e701019c47..1f4c29d4ad 100644 --- a/docs/command/atlas-streams-instances-describe.txt +++ b/docs/command/atlas-streams-instances-describe.txt @@ -14,6 +14,11 @@ atlas streams instances describe Describe an Atlas Stream Processing instance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-instances-download.txt b/docs/command/atlas-streams-instances-download.txt index 8cee843c81..9407e81fcf 100644 --- a/docs/command/atlas-streams-instances-download.txt +++ b/docs/command/atlas-streams-instances-download.txt @@ -14,6 +14,11 @@ atlas streams instances download Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-streams-instances-list.txt b/docs/command/atlas-streams-instances-list.txt index 43620f92c8..164d1dc330 100644 --- a/docs/command/atlas-streams-instances-list.txt +++ b/docs/command/atlas-streams-instances-list.txt @@ -14,6 +14,11 @@ atlas streams instances list List all the Atlas Stream Processing instances for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-instances-update.txt b/docs/command/atlas-streams-instances-update.txt index fb6875d5fa..edbbd29a28 100644 --- a/docs/command/atlas-streams-instances-update.txt +++ b/docs/command/atlas-streams-instances-update.txt @@ -14,6 +14,11 @@ atlas streams instances update Updates an Atlas Stream Processing instance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-streams-instances.txt b/docs/command/atlas-streams-instances.txt index 88cb43a8a5..1d6cd3a275 100644 --- a/docs/command/atlas-streams-instances.txt +++ b/docs/command/atlas-streams-instances.txt @@ -14,6 +14,11 @@ atlas streams instances Manage Atlas Stream Processing instances. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list, update and delete your Atlas Stream Processing instances. Options diff --git a/docs/command/atlas-streams-privateLinks-create.txt b/docs/command/atlas-streams-privateLinks-create.txt index ff0d3d6fe9..24fbd53efc 100644 --- a/docs/command/atlas-streams-privateLinks-create.txt +++ b/docs/command/atlas-streams-privateLinks-create.txt @@ -14,6 +14,11 @@ atlas streams privateLinks create Creates a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-delete.txt b/docs/command/atlas-streams-privateLinks-delete.txt index 9d7ca42f84..cec3782bf0 100644 --- a/docs/command/atlas-streams-privateLinks-delete.txt +++ b/docs/command/atlas-streams-privateLinks-delete.txt @@ -14,6 +14,11 @@ atlas streams privateLinks delete Deletes an Atlas Stream Processing PrivateLink endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-describe.txt b/docs/command/atlas-streams-privateLinks-describe.txt index 202502f7ec..aa3027e9ad 100644 --- a/docs/command/atlas-streams-privateLinks-describe.txt +++ b/docs/command/atlas-streams-privateLinks-describe.txt @@ -14,6 +14,11 @@ atlas streams privateLinks describe Describes a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-list.txt b/docs/command/atlas-streams-privateLinks-list.txt index 064f1e9cf7..c3f132d634 100644 --- a/docs/command/atlas-streams-privateLinks-list.txt +++ b/docs/command/atlas-streams-privateLinks-list.txt @@ -14,6 +14,11 @@ atlas streams privateLinks list Lists the PrivateLink endpoints in the project that can be used as Atlas Stream Processor connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks.txt b/docs/command/atlas-streams-privateLinks.txt index 47740b5d20..1665d31265 100644 --- a/docs/command/atlas-streams-privateLinks.txt +++ b/docs/command/atlas-streams-privateLinks.txt @@ -14,6 +14,11 @@ atlas streams privateLinks Manage Atlas Stream Processing PrivateLink endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create your Atlas Stream Processing PrivateLink endpoints Options diff --git a/docs/command/atlas-streams.txt b/docs/command/atlas-streams.txt index d0a648bac8..5a458be2d6 100644 --- a/docs/command/atlas-streams.txt +++ b/docs/command/atlas-streams.txt @@ -14,6 +14,11 @@ atlas streams Manage your Atlas Stream Processing deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. Options diff --git a/docs/command/atlas-teams-create.txt b/docs/command/atlas-teams-create.txt index 9bb807539e..83bfc9fccf 100644 --- a/docs/command/atlas-teams-create.txt +++ b/docs/command/atlas-teams-create.txt @@ -14,6 +14,11 @@ atlas teams create Create a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-teams-delete.txt b/docs/command/atlas-teams-delete.txt index 3be0a283e1..d75e4b6c4b 100644 --- a/docs/command/atlas-teams-delete.txt +++ b/docs/command/atlas-teams-delete.txt @@ -14,6 +14,11 @@ atlas teams delete Remove the specified team from your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-teams-describe.txt b/docs/command/atlas-teams-describe.txt index e13b21c7d0..ca91b21dca 100644 --- a/docs/command/atlas-teams-describe.txt +++ b/docs/command/atlas-teams-describe.txt @@ -14,6 +14,11 @@ atlas teams describe Return the details for the specified team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-teams-list.txt b/docs/command/atlas-teams-list.txt index f454ff6762..dd50da867d 100644 --- a/docs/command/atlas-teams-list.txt +++ b/docs/command/atlas-teams-list.txt @@ -14,6 +14,11 @@ atlas teams list Return all teams for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-teams-rename.txt b/docs/command/atlas-teams-rename.txt index 867a75b2f8..4579c28dd5 100644 --- a/docs/command/atlas-teams-rename.txt +++ b/docs/command/atlas-teams-rename.txt @@ -14,6 +14,11 @@ atlas teams rename Rename a team in your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-teams-users-add.txt b/docs/command/atlas-teams-users-add.txt index eeb6319874..355c84ab3d 100644 --- a/docs/command/atlas-teams-users-add.txt +++ b/docs/command/atlas-teams-users-add.txt @@ -14,6 +14,11 @@ atlas teams users add Add the specified MongoDB user to a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can add users that are part of the organization or users that have been sent an invitation to join the organization. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-teams-users-delete.txt b/docs/command/atlas-teams-users-delete.txt index 4cd64e07bd..bd9495fb65 100644 --- a/docs/command/atlas-teams-users-delete.txt +++ b/docs/command/atlas-teams-users-delete.txt @@ -14,6 +14,11 @@ atlas teams users delete Remove the specified user from a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-teams-users-list.txt b/docs/command/atlas-teams-users-list.txt index ae494e0213..6c24a4fd05 100644 --- a/docs/command/atlas-teams-users-list.txt +++ b/docs/command/atlas-teams-users-list.txt @@ -14,6 +14,11 @@ atlas teams users list Return all users for a team. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-teams-users.txt b/docs/command/atlas-teams-users.txt index d8724b0790..1da6bd8d9b 100644 --- a/docs/command/atlas-teams-users.txt +++ b/docs/command/atlas-teams-users.txt @@ -14,6 +14,11 @@ atlas teams users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your users. Options diff --git a/docs/command/atlas-teams.txt b/docs/command/atlas-teams.txt index a32ada2f2b..fb5675a7f7 100644 --- a/docs/command/atlas-teams.txt +++ b/docs/command/atlas-teams.txt @@ -14,6 +14,11 @@ atlas teams Manage your Atlas teams. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your Atlas teams. Options diff --git a/docs/command/atlas-users-describe.txt b/docs/command/atlas-users-describe.txt index 4ec47d18a5..039d628e30 100644 --- a/docs/command/atlas-users-describe.txt +++ b/docs/command/atlas-users-describe.txt @@ -14,6 +14,11 @@ atlas users describe Return the details for the specified Atlas user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. User accounts and API keys with any role can run this command. diff --git a/docs/command/atlas-users-invite.txt b/docs/command/atlas-users-invite.txt index 7b5ebd3250..f2b351604c 100644 --- a/docs/command/atlas-users-invite.txt +++ b/docs/command/atlas-users-invite.txt @@ -14,6 +14,11 @@ atlas users invite Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. Syntax diff --git a/docs/command/atlas-users.txt b/docs/command/atlas-users.txt index 7507d266ab..08d0588408 100644 --- a/docs/command/atlas-users.txt +++ b/docs/command/atlas-users.txt @@ -14,6 +14,11 @@ atlas users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create and manage your Atlas users. Options diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index f6ab91e6a5..a19aa90b59 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -14,6 +14,11 @@ atlas CLI tool to manage MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. Use the --help flag with any command for more info on that command. @@ -53,7 +58,7 @@ Related Commands * :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. * :ref:`atlas-accessLogs` - Return the access logs for a cluster. * :ref:`atlas-alerts` - Manage alerts for your project. -* :ref:`atlas-api` - Public Preview: please provide feedback at : Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +* :ref:`atlas-api` - `Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. * :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. * :ref:`atlas-auth` - Manage the CLI's authentication state. * :ref:`atlas-backups` - Manage cloud backups for your project. diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 026d17da99..374b048e10 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -71,7 +71,7 @@ func Builder() *cobra.Command { func createRootAPICommand() *cobra.Command { rootCmd := &cobra.Command{ Use: "api", - Short: `Public Preview: please provide feedback at : Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '.`, + Short: "`Public Preview: please provide feedback `_: " + `Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '.`, Long: `This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. For more information on diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index 7ccc350043..b44501d8ab 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -15,11 +15,18 @@ package cli const ( - // Help template + // HelpTemplate // Modified version of https://github.com/spf13/cobra/blob/01ffff4eca5a08384ef2b85f39ec0dac192a5f7b/command.go#L595 which shows both .Short and .Long help descriptions. HelpTemplate = `{{.Short | trimTrailingWhitespaces}} {{.Long | trimTrailingWhitespaces}} {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ExperimentalHelpTemplate = "Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli.\n\n" + HelpTemplate + ExperimentalText = "Public Preview: The atlas api sub-command, " + + "automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and " + + "is currently in Public Preview (please provide feedback " + + "at https://feedback.mongodb.com/forums/930808-atlas-cli).\n" + + "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + + "documentation link.\n\n" + + ExperimentalHelpTemplate = ExperimentalText + HelpTemplate ) diff --git a/tools/cmd/docs/api_docs_long_text.txt b/tools/cmd/docs/api_docs_long_text.txt index 72b7bde10a..437e048461 100644 --- a/tools/cmd/docs/api_docs_long_text.txt +++ b/tools/cmd/docs/api_docs_long_text.txt @@ -1,5 +1,5 @@ -This feature in public preview streamlines script development by letting you interact -directly with any Atlas Administration API endpoint by using the Atlas CLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Syntax ------ @@ -114,4 +114,4 @@ In addition, the following options are available for all Atlas Administration AP * - ``-h, --help`` - boolean - false - - Help for the current command. \ No newline at end of file + - Help for the current command. diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index f3db029b52..748c07515f 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -22,6 +22,7 @@ import ( "strconv" "strings" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli" pluginCmd "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/internal/metadatatypes" @@ -40,6 +41,7 @@ var additionalLongTexts = map[string]string{ func addAdditionalLongText(cmd *cobra.Command) { commandPath := cmd.CommandPath() + cmd.Long = cli.ExperimentalText + "\n\n" + cmd.Long if additionalLongText, found := additionalLongTexts[commandPath]; found && additionalLongText != "" { cmd.Long += "\n\n" cmd.Long += additionalLongText @@ -58,7 +60,7 @@ func markExperimentalToAPICommands(cmd *cobra.Command) { if cmd.CommandPath() == "atlas api" { return // Skip the root command } - cmd.Short = "`Public Preview: please provide feedback at `_: " + cmd.Short + cmd.Short = "`Public Preview: please provide feedback `_: " + cmd.Short } func updateAPICommandDescription(cmd *cobra.Command) {