diff --git a/docs/command/atlas-accessLists-create.txt b/docs/command/atlas-accessLists-create.txt index a9bb62b992..f6bd387293 100644 --- a/docs/command/atlas-accessLists-create.txt +++ b/docs/command/atlas-accessLists-create.txt @@ -14,11 +14,6 @@ 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 26a09e1af8..9422e69964 100644 --- a/docs/command/atlas-accessLists-delete.txt +++ b/docs/command/atlas-accessLists-delete.txt @@ -14,11 +14,6 @@ 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 2916020639..b759f71cff 100644 --- a/docs/command/atlas-accessLists-describe.txt +++ b/docs/command/atlas-accessLists-describe.txt @@ -14,11 +14,6 @@ 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 e2c003b9a6..7fc068133f 100644 --- a/docs/command/atlas-accessLists-list.txt +++ b/docs/command/atlas-accessLists-list.txt @@ -14,11 +14,6 @@ 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 19b36580ea..0c5ab90ee3 100644 --- a/docs/command/atlas-accessLists.txt +++ b/docs/command/atlas-accessLists.txt @@ -14,13 +14,6 @@ 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 eeefb6a3c2..c93e3257ba 100644 --- a/docs/command/atlas-accessLogs-list.txt +++ b/docs/command/atlas-accessLogs-list.txt @@ -14,11 +14,6 @@ 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 4e0a23cf30..6af9d05156 100644 --- a/docs/command/atlas-accessLogs.txt +++ b/docs/command/atlas-accessLogs.txt @@ -14,13 +14,6 @@ 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 f66d042066..45e26529e5 100644 --- a/docs/command/atlas-alerts-acknowledge.txt +++ b/docs/command/atlas-alerts-acknowledge.txt @@ -14,11 +14,6 @@ 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 d95dbd7ee8..e67a940624 100644 --- a/docs/command/atlas-alerts-describe.txt +++ b/docs/command/atlas-alerts-describe.txt @@ -14,11 +14,6 @@ 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 774d3faa92..1152d673ee 100644 --- a/docs/command/atlas-alerts-list.txt +++ b/docs/command/atlas-alerts-list.txt @@ -14,11 +14,6 @@ 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 ab19560667..87a1e7c5f3 100644 --- a/docs/command/atlas-alerts-settings-create.txt +++ b/docs/command/atlas-alerts-settings-create.txt @@ -14,11 +14,6 @@ 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 d33d5acb04..8e22299a39 100644 --- a/docs/command/atlas-alerts-settings-delete.txt +++ b/docs/command/atlas-alerts-settings-delete.txt @@ -14,11 +14,6 @@ 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 9125c794ab..323cc68fb3 100644 --- a/docs/command/atlas-alerts-settings-describe.txt +++ b/docs/command/atlas-alerts-settings-describe.txt @@ -14,11 +14,6 @@ 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 360c0e8f32..c63bbd5355 100644 --- a/docs/command/atlas-alerts-settings-disable.txt +++ b/docs/command/atlas-alerts-settings-disable.txt @@ -14,13 +14,6 @@ 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 81ceb0be67..9e54331291 100644 --- a/docs/command/atlas-alerts-settings-enable.txt +++ b/docs/command/atlas-alerts-settings-enable.txt @@ -14,13 +14,6 @@ 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 09252b546c..891a1ed723 100644 --- a/docs/command/atlas-alerts-settings-fields-type.txt +++ b/docs/command/atlas-alerts-settings-fields-type.txt @@ -14,11 +14,6 @@ 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 2500a9b548..1f04c66bc9 100644 --- a/docs/command/atlas-alerts-settings-fields.txt +++ b/docs/command/atlas-alerts-settings-fields.txt @@ -14,13 +14,6 @@ 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 6b996a3957..18033d8ba0 100644 --- a/docs/command/atlas-alerts-settings-list.txt +++ b/docs/command/atlas-alerts-settings-list.txt @@ -14,11 +14,6 @@ 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 6a08acaeda..a5355972e7 100644 --- a/docs/command/atlas-alerts-settings-update.txt +++ b/docs/command/atlas-alerts-settings-update.txt @@ -14,11 +14,6 @@ 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 64b230daf4..54f985bec4 100644 --- a/docs/command/atlas-alerts-settings.txt +++ b/docs/command/atlas-alerts-settings.txt @@ -14,11 +14,6 @@ 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 6c7aa958ed..9d66e0b105 100644 --- a/docs/command/atlas-alerts-unacknowledge.txt +++ b/docs/command/atlas-alerts-unacknowledge.txt @@ -14,11 +14,6 @@ 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 bdd82ef0fd..75f0f7159e 100644 --- a/docs/command/atlas-alerts.txt +++ b/docs/command/atlas-alerts.txt @@ -14,13 +14,6 @@ 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 7c2ef8da98..e4fd0badd0 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -14,11 +14,9 @@ atlas api accessTracking listAccessLogsByClusterName `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyclustername. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 4d3e1aae34..23929130e9 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -14,11 +14,9 @@ atlas api accessTracking listAccessLogsByHostname `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyhostname. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 0ebddc346b..68e725ffd7 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -14,11 +14,9 @@ atlas api accessTracking `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/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. Options diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 8206aaa227..53e5b47fc1 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations createAlertConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 17ed1888ff..44e11138f1 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations deleteAlertConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 b6e35e9962..6f2c38be7a 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations getAlertConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 6528a1c236..7e15c686b3 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurationmatchersfieldnames. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index dfefb67b38..ba26f6986d 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations listAlertConfigurations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 52744d92ba..d4a76aa046 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 9d2efddf28..fca89ddbff 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations toggleAlertConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 66fb3a1031..68f9f9ed1b 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations updateAlertConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 094904ce1f..4dc2b34377 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -14,11 +14,9 @@ atlas api alertConfigurations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index 3028707a8a..9c0d165150 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -14,11 +14,9 @@ atlas api alerts acknowledgeAlert `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 7a037b0fb9..d4220dac65 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -14,11 +14,9 @@ atlas api alerts getAlert `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 6dfbf09afe..fc8e60e9c6 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -14,11 +14,9 @@ atlas api alerts listAlerts `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 0d820931f6..369a4c0bdd 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -14,11 +14,9 @@ atlas api alerts listAlertsByAlertConfigurationId `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 ac8b7cc15c..ceaa4a22b1 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -14,11 +14,9 @@ atlas api alerts `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 4707c04e66..8b7f0c4de4 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -14,11 +14,9 @@ atlas api atlasSearch createAtlasSearchDeployment `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 094241d605..37fe0bcba8 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -14,11 +14,9 @@ atlas api atlasSearch createAtlasSearchIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 78fd33f48d..e76e3e63eb 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -14,11 +14,9 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 4b201b70b5..7c37646cfe 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -14,11 +14,9 @@ atlas api atlasSearch deleteAtlasSearchDeployment `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index cc34af0018..e18cf884ae 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -14,11 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index b4ce968adf..529fd65db1 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -14,11 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndexByName `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 4072e8a7a9..6e7e94436d 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -14,11 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 29b64a95ad..551d496121 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -14,11 +14,9 @@ atlas api atlasSearch getAtlasSearchDeployment `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index b123203f5a..4e24895c23 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -14,11 +14,9 @@ atlas api atlasSearch getAtlasSearchIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index c651f51d98..80d70bdd49 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index fd0d32a261..2acba5b882 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -14,11 +14,9 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 77b1635a94..8cfdca193c 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -14,11 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexes `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexes. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index 27d4b5d303..f8a8899f52 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -14,11 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexesCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexescluster. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 4c9dd36bd4..031e07c694 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -14,11 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexesdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 93c99c7b0a..01e7b5a2f9 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -14,11 +14,9 @@ atlas api atlasSearch updateAtlasSearchDeployment `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 0e3f45e252..b096c6dfbf 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -14,11 +14,9 @@ atlas api atlasSearch updateAtlasSearchIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index c2bf86fe68..07dfdad1b6 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index eb25d597fa..fa2ab9bd32 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -14,11 +14,9 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index 8ce859650f..bb650c3628 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -14,11 +14,9 @@ atlas api atlasSearch `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index be87dc46d6..e860e9bd78 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -14,11 +14,9 @@ atlas api auditing getAuditingConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getauditingconfiguration. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index 287c6f9e16..65f5cb25da 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -14,11 +14,9 @@ atlas api auditing updateAuditingConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateauditingconfiguration. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 26b4564a7f..0cd3df8d11 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -14,13 +14,11 @@ atlas api auditing `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index 515e7d0276..f91ceffec5 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -14,11 +14,9 @@ atlas api awsClustersDns getAwsCustomDns `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getawscustomdns. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index c0899091ae..b873f60300 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -14,11 +14,9 @@ atlas api awsClustersDns toggleAwsCustomDns `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleawscustomdns. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 9dfe02b19e..025ed45180 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -14,11 +14,9 @@ atlas api awsClustersDns `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 8bf06fdc70..fd68659f5c 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups cancelBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cancelbackuprestorejob. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index f5e67763fc..4e5ee99f7f 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups createBackupExportJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createbackupexportjob. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 1fe024b495..1dac6b3903 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups createBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 443eb2c7f6..afd330ae35 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 87e81eca19..3748ff9b06 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups createServerlessBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 425c7663dd..937c7c05e2 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -14,11 +14,9 @@ atlas api cloudBackups deleteAllBackupSchedules `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallbackupschedules. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 5888ee0097..3aff0065e1 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -14,11 +14,9 @@ atlas api cloudBackups deleteExportBucket `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index ce47da7125..854537ab91 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -14,11 +14,9 @@ atlas api cloudBackups deleteReplicaSetBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletereplicasetbackup. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index f8f90f448d..01f2edb5e7 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -14,11 +14,9 @@ atlas api cloudBackups deleteShardedClusterBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteshardedclusterbackup. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 2ce69b5555..82c05fd0dd 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -14,11 +14,9 @@ atlas api cloudBackups disableDataProtectionSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disabledataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 8cf1afbb7d..3d90c9c923 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getBackupExportJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupexportjob. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 21a140ebc2..861d7e6760 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackuprestorejob. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 97ccfff345..7795a2a261 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getBackupSchedule `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupschedule. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index e1ba24c444..83619024ed 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getDataProtectionSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index dec17c70e4..868a275e3a 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getExportBucket `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index e27b477b4b..dafbaf3368 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getReplicaSetBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getreplicasetbackup. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 7616afd527..72af10a289 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getServerlessBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 a09c17a855..cc3a8eb1bc 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getServerlessBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 d8d8190ad6..71f5ee1eea 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -14,11 +14,9 @@ atlas api cloudBackups getShardedClusterBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getshardedclusterbackup. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 45be565a53..52201dd823 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listBackupExportJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackupexportjobs. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index bcee154dcc..a5b2798ba0 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listBackupRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackuprestorejobs. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 1bda981327..121b6b9af0 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listExportBuckets `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listexportbuckets. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index df197fa147..7a12e2f0e6 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listReplicaSetBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listreplicasetbackups. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 5c6f91217f..c024b09ca8 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listServerlessBackupRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 31c4feb8bc..9d53431410 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listServerlessBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 736187b5fe..3678723bd4 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -14,11 +14,9 @@ atlas api cloudBackups listShardedClusterBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listshardedclusterbackups. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index ee45d4ab38..3eebc51358 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -14,11 +14,9 @@ atlas api cloudBackups takeSnapshot `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 0b9db3a6e3..2d49672b13 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -14,11 +14,9 @@ atlas api cloudBackups updateBackupSchedule `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatebackupschedule. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 8790f04224..48046b4020 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -14,11 +14,9 @@ atlas api cloudBackups updateDataProtectionSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index b41e4849eb..2966a0b12c 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatesnapshotretention. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 0af954f8fc..8676164f20 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -14,11 +14,9 @@ atlas api cloudBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index ae1fe45b79..c1c362ad3d 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService createLinkToken `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlinktoken. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 5964535fb1..35d0382e0a 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService createPushMigration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 567db86b90..fc47a63982 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService cutoverMigration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cutovermigration. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index c689db297c..e56f8ff7c1 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService deleteLinkToken `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelinktoken. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index f012c2b7b5..9f0731e3b4 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService getPushMigration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpushmigration. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index ac5b0364fa..3ec67f200c 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService getValidationStatus `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getvalidationstatus. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 7fea792ffb..7451741383 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService listSourceProjects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listsourceprojects. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index 41f2fac6c6..c9e78c36ed 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validatemigration. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 26af550033..07f47eba6c 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -14,11 +14,9 @@ atlas api cloudMigrationService `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 3578fd1a30..eb3b85417f 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -14,11 +14,9 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-authorizecloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index d85038fff2..caa10ec372 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -14,11 +14,9 @@ atlas api cloudProviderAccess createCloudProviderAccessRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 55763a997d..2bf570e133 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -14,11 +14,9 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deauthorizecloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index 94281e4bc6..cfef189067 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -14,11 +14,9 @@ atlas api cloudProviderAccess getCloudProviderAccessRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 5bea11543a..2f377a18db 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -14,11 +14,9 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudprovideraccessroles. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index 6454c844c1..3076e1ccfb 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -14,13 +14,11 @@ atlas api cloudProviderAccess `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index 65f3123a93..dff06016d5 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -14,11 +14,9 @@ atlas api clusterOutageSimulation endOutageSimulation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-endoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index 805fd8a7ad..f91a74a59f 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -14,11 +14,9 @@ atlas api clusterOutageSimulation getOutageSimulation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index 854f902754..608c8efd7e 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -14,11 +14,9 @@ atlas api clusterOutageSimulation startOutageSimulation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-startoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index c189351ae6..5cd64160be 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -14,13 +14,11 @@ atlas api clusterOutageSimulation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index 1c181d5a3a..d236494c46 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -14,11 +14,9 @@ atlas api clusters autoScalingConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-autoscalingconfiguration. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 46bdc47ea4..3f158b43eb 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -14,11 +14,9 @@ atlas api clusters createCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 98f72c853e..6d0e4338a8 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -14,11 +14,9 @@ atlas api clusters deleteCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 5c3690f838..970b1d81d9 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -14,11 +14,9 @@ atlas api clusters getCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 29e51c3fde..315a1342e3 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -14,11 +14,9 @@ atlas api clusters getClusterAdvancedConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusteradvancedconfiguration. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index 0343d042a7..e12efec779 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusterstatus. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 21e59d8f33..ffaa8948b4 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -14,11 +14,9 @@ atlas api clusters getSampleDatasetLoadStatus `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsampledatasetloadstatus. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 32d6dba60a..3b37fc1bb1 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-grantmongodbemployeeaccess. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index ac4124246a..8b700284df 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -14,11 +14,9 @@ atlas api clusters listCloudProviderRegions `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudproviderregions. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index f51a253a6c..08481808b3 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -14,11 +14,9 @@ atlas api clusters listClusters `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 cfd33c7a57..6364418c6b 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -14,11 +14,9 @@ atlas api clusters listClustersForAllProjects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersforallprojects. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 65fe53ba5b..039ca709e2 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -14,11 +14,9 @@ atlas api clusters loadSampleDataset `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-loadsampledataset. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 59b9677c4f..6bc18e0042 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinfeaturecompatibilityversion. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 9e71132bfa..a0b8b03da4 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -14,11 +14,9 @@ atlas api clusters revokeMongoDbEmployeeAccess `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-revokemongodbemployeeaccess. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 5f8884544c..f406c9df38 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -14,11 +14,9 @@ atlas api clusters testFailover `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-testfailover. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index c1fe4d01dd..e4c3b0ef6c 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -14,11 +14,9 @@ atlas api clusters unpinFeatureCompatibilityVersion `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpinfeaturecompatibilityversion. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index b3dd2a09a2..880827fe4d 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -14,11 +14,9 @@ atlas api clusters updateCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecluster. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index b86fd0f1c7..310257d94f 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -14,11 +14,9 @@ atlas api clusters updateClusterAdvancedConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateclusteradvancedconfiguration. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index d6320872f5..6fe8d74664 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 fe4ff5137f..ed4e705dfe 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -14,11 +14,9 @@ atlas api clusters `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 82fdc4c9c6..ea3491f1cb 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -14,11 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespaceclustermeasurements. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 4d16cdccb6..9cba091588 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -14,11 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacehostmeasurements. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 241c69e174..f6fa24af73 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacemetrics. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 9d34c7b5ec..5ad7973c33 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforcluster. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index b41943c04e..834d236f10 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforhost. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 821b1d6e86..525b00442c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getpinnednamespaces. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index bfa3a635d7..b5f33bf709 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacespatch. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index c12e1f4174..ae8e47f2bf 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacesput. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 58bd042c1a..96fdaa2f94 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-unpinnamespaces. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 742e9e2497..e69686c020 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -14,11 +14,9 @@ atlas api collectionLevelMetrics `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 555d30cbbf..cddd1c8724 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles createCustomDatabaseRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index b9cc38380d..0e61e06502 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index bd6dc4eca4..6239d4dfe4 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles getCustomDatabaseRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index bb3a1f15e4..eaf6020d91 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles listCustomDatabaseRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcustomdatabaseroles. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index e69643fe87..fc82f6c07b 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles updateCustomDatabaseRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 1e366e97b9..7c4bf67455 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -14,11 +14,9 @@ atlas api customDatabaseRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index 688d298d14..54510afedc 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api dataFederation createDataFederationPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 c87afa14b2..4759615bff 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -14,11 +14,9 @@ atlas api dataFederation createFederatedDatabase `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index 0f95fb416c..e90a642764 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -14,11 +14,9 @@ atlas api dataFederation createOneDataFederationQueryLimit `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonedatafederationquerylimit. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 79d622a608..0bd95c9773 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatafederationprivateendpoint. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index c74e3f5938..493745465c 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -14,11 +14,9 @@ atlas api dataFederation deleteFederatedDatabase `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 0ff753e5f6..f97cab75db 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -14,11 +14,9 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonedatafederationinstancequerylimit. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 9303da8fb7..d45c5490e8 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -14,11 +14,9 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadfederateddatabasequerylogs. diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index f8443e5bea..e6ab64cea4 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatafederationprivateendpoint. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index 2826ded459..e5d2b182a7 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -14,11 +14,9 @@ atlas api dataFederation getFederatedDatabase `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index cc012f8299..4e4ec88db0 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -14,11 +14,9 @@ atlas api dataFederation listDataFederationPrivateEndpoints `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatafederationprivateendpoints. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 27ac636b0d..1afeeb6250 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -14,11 +14,9 @@ atlas api dataFederation listFederatedDatabases `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederateddatabases. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 56e5423d5e..df56bb033d 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimit. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index f193048bfb..ef07babdc1 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -14,11 +14,9 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimits. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index a7edfeb945..e209bbcefd 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -14,11 +14,9 @@ atlas api dataFederation updateFederatedDatabase `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederateddatabase. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index 9c3ef77362..4e39e60b74 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -14,11 +14,9 @@ atlas api dataFederation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt index 8ee1e58fd1..b511035544 100644 --- a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines createPipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createpipeline. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt index f79520d762..8bd36b52a6 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines deletePipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deletepipeline. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 4ea3241780..ce01198bbb 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines deletePipelineRunDataset `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deletepipelinerundataset. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt index 63f9a0d8ba..274822437e 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines getPipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index 6560accb15..3d462f1705 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines getPipelineRun `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpipelinerun. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 685757cf96..7d73dbd25e 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines listPipelineRuns `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpipelineruns. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 7bf9eb2fd7..22dc856521 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpipelineschedules. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index c7aed01df4..340b1a7e9d 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpipelinesnapshots. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index 8515a60d5b..d8cd02ecdb 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines listPipelines `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpipelines. diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index 8d16f30720..8065791f34 100644 --- a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines pausePipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pausepipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index 4c665acee2..7f8858d3e5 100644 --- a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines resumePipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resumepipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index 9afd508eeb..6fa3b223b0 100644 --- a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines triggerSnapshotIngestion `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-triggersnapshotingestion. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt index cec84f3012..486bebc8f3 100644 --- a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -14,11 +14,9 @@ atlas api dataLakePipelines updatePipeline `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updatepipeline. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-dataLakePipelines.txt b/docs/command/atlas-api-dataLakePipelines.txt index 1c79ff1023..4224c42469 100644 --- a/docs/command/atlas-api-dataLakePipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines.txt @@ -14,13 +14,11 @@ atlas api dataLakePipelines `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index a6992f9d8c..c6a881abda 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -14,11 +14,9 @@ atlas api databaseUsers createDatabaseUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index 1f94496346..a0dab0c03e 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -14,11 +14,9 @@ atlas api databaseUsers deleteDatabaseUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index 47f382fde3..f982191688 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -14,11 +14,9 @@ atlas api databaseUsers getDatabaseUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index 9471612dc3..6afcd62d89 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -14,11 +14,9 @@ atlas api databaseUsers listDatabaseUsers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusers. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 014673d6d2..e3605a7893 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -14,11 +14,9 @@ atlas api databaseUsers updateDatabaseUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 8b6f4986b2..a4b211cfb4 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -14,13 +14,11 @@ atlas api databaseUsers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 7d51316308..50d7f5e979 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createencryptionatrestprivateendpoint. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 0acc2379ba..27e582e378 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 283ddf4921..a5ce596a19 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpoint. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index a6ec617cd7..cbb9fb3dcf 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -14,11 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpointsforcloudprovider. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 7ad7d0ce04..0adc5345dd 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -14,11 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-requestencryptionatrestprivateendpointdeletion. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index d927791e7c..7936d87b39 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 13e519603d..46dc2bea9f 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -14,11 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index 90fddb9fd7..5aae2493b7 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -14,11 +14,9 @@ atlas api events getOrganizationEvent `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 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 acc082a3b2..6d3f469ae6 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -14,11 +14,9 @@ atlas api events getProjectEvent `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 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 14779fd353..f1923a7960 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listeventtypes. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index 684aefff55..41500d5a07 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -14,11 +14,9 @@ atlas api events listOrganizationEvents `Public Preview: please provide feedback `_: Returns 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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 42b4a48943..bb46fca30b 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -14,11 +14,9 @@ atlas api events listProjectEvents `Public Preview: please provide feedback `_: Returns 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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 5eca9eb139..b2a943d274 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -14,11 +14,9 @@ atlas api 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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index 5c6c61b573..d9d3fedef7 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication createIdentityProvider `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 ee3069cd5f..14a97847a5 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication createRoleMapping `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 8ef28bf5dd..e6a3ceee82 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication deleteFederationApp `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationapp. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index 19ca2a9ac2..672abe6d2f 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication deleteIdentityProvider `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 2cddc0b725..b310b65f50 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication deleteRoleMapping `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleterolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index db63ef1687..2aee3a4c3b 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication getConnectedOrgConfig `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getconnectedorgconfig. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index 3269730233..c052eef5d9 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication getFederationSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettings. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index f6e32d21d2..bb6ae01a6c 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication getIdentityProvider `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovider. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 78741f6bd1..327dff2a99 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication getIdentityProviderMetadata `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovidermetadata. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index f5f9657b38..85736bc33f 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication getRoleMapping `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getrolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index 06fa783a93..1d67d4e252 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication listConnectedOrgConfigs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listconnectedorgconfigs. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 69857692ed..345a92a0d7 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication listIdentityProviders `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listidentityproviders. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 66d057284b..847183dc6a 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication listRoleMappings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listrolemappings. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index b8f484220b..02e75700bb 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication removeConnectedOrgConfig `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeconnectedorgconfig. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 224bb8caff..4c92f428a4 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 2f87620a44..8c8bd42f72 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication updateConnectedOrgConfig `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 fd9cc51862..0c37d319be 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication updateIdentityProvider `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 34e6e802d0..f6cbdf0492 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -14,11 +14,9 @@ atlas api federatedAuthentication updateRoleMapping `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updaterolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index fe3858d011..641db9b072 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -14,13 +14,11 @@ atlas api federatedAuthentication `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index 941c4f2415..6230433631 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -14,11 +14,9 @@ atlas api flexClusters createFlexCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexcluster. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index e69933a50b..bf8d6fedd4 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -14,11 +14,9 @@ atlas api flexClusters deleteFlexCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteflexcluster. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 8950d4be16..f0001be21e 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -14,11 +14,9 @@ atlas api flexClusters getFlexCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexcluster. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 8276ee3485..4b96e02398 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -14,11 +14,9 @@ atlas api flexClusters listFlexClusters `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexclusters. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 13660a36fd..0389fa29a3 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -14,11 +14,9 @@ atlas api flexClusters updateFlexCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateflexcluster. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 89d1dc0909..fc0d58a06d 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -14,11 +14,9 @@ atlas api flexClusters upgradeFlexCluster `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradeflexcluster. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 26006f16d1..3df453a573 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -14,13 +14,11 @@ atlas api flexClusters `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index ac6d3ac2c8..740f1ad825 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexbackuprestorejob. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index c36e73d14a..6784778286 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackuprestorejob. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 0265e74f3c..7f9ef2bc42 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -14,11 +14,9 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackuprestorejobs. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 60d27b2e76..af1e93c687 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -14,13 +14,11 @@ atlas api flexRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index f197199cf4..357e8c63e0 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -14,11 +14,9 @@ atlas api flexSnapshots downloadFlexBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadflexbackup. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index 339887d298..a4db3d69b0 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -14,11 +14,9 @@ atlas api flexSnapshots getFlexBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackup. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index e409f2e7fe..e66a06c592 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -14,11 +14,9 @@ atlas api flexSnapshots listFlexBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackups. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 68eed67439..a284c15a44 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -14,13 +14,11 @@ atlas api flexSnapshots `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 197d84a56b..678ce58271 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -14,11 +14,9 @@ atlas api globalClusters createCustomZoneMapping `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomzonemapping. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 11b4cdb80c..021d545786 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -14,11 +14,9 @@ atlas api globalClusters createManagedNamespace `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createmanagednamespace. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 770e8f4f1d..147ab2a78c 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -14,11 +14,9 @@ atlas api globalClusters deleteAllCustomZoneMappings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallcustomzonemappings. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index 162689fe31..ee636b332d 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -14,11 +14,9 @@ atlas api globalClusters deleteManagedNamespace `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletemanagednamespace. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index d3176646ab..d07ba6c19d 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -14,11 +14,9 @@ atlas api globalClusters getManagedNamespace `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmanagednamespace. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 61febfcba7..1c7dc58029 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -14,11 +14,9 @@ atlas api globalClusters `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 01b3a122dc..2a64115c66 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -14,11 +14,9 @@ atlas api invoices createCostExplorerQueryProcess `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcostexplorerqueryprocess. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index c5e3c471e8..91757d9e8d 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -14,11 +14,9 @@ atlas api invoices downloadInvoiceCsv `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 c28cee0f03..c2ec03fe4c 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcostexplorerqueryprocess. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index 686a8df0e0..cceb2efcd7 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -14,11 +14,9 @@ atlas api invoices getInvoice `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 422bb5b4ca..375ace7246 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -14,11 +14,9 @@ atlas api invoices listInvoices `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 565591c4b2..f893f2b719 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -14,11 +14,9 @@ atlas api invoices listPendingInvoices `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpendinginvoices. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 1950faf539..68783354ff 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -14,11 +14,9 @@ atlas api invoices queryLineItemsFromSingleInvoice `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-querylineitemsfromsingleinvoice. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 4918bd1119..d94df194e7 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -14,13 +14,11 @@ atlas api 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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 5442cde2d0..b029940d7f 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 43374ee201..102b5169c5 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -14,11 +14,9 @@ atlas api ldapConfiguration getLdapConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index c255d4423c..b24fd93e13 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -14,11 +14,9 @@ atlas api ldapConfiguration getLdapConfigurationStatus `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfigurationstatus. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index 926e4d69fc..e11f80f92e 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -14,11 +14,9 @@ atlas api ldapConfiguration saveLdapConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 fa777ebfcd..711f109a4e 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -14,11 +14,9 @@ atlas api ldapConfiguration verifyLdapConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index c56abd5261..0bd261b391 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -14,11 +14,9 @@ atlas api ldapConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index e32e0cf1c8..8908543bac 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api legacyBackup createLegacyBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlegacybackuprestorejob. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index cfe7a5fd79..8937f4e5b6 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -14,11 +14,9 @@ atlas api legacyBackup deleteLegacySnapshot `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelegacysnapshot. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index 7ac59d44ef..a68d8d0240 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -14,11 +14,9 @@ atlas api legacyBackup getLegacyBackupCheckpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacybackupcheckpoint. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 9c83a730c2..d66027d40d 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api legacyBackup getLegacyBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 cbb85ea239..108f4bf66d 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -14,11 +14,9 @@ atlas api legacyBackup getLegacySnapshot `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacysnapshot. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 0cd4af44a2..f02333810a 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -14,11 +14,9 @@ atlas api legacyBackup getLegacySnapshotSchedule `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 8edf2e6ae2..02d692d370 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -14,11 +14,9 @@ atlas api legacyBackup listLegacyBackupCheckpoints `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacybackupcheckpoints. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index 1c53c4e7e4..c86e97d0d0 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -14,11 +14,9 @@ atlas api legacyBackup listLegacyBackupRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 fe18d4d2b9..87e2e03f93 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -14,11 +14,9 @@ atlas api legacyBackup listLegacySnapshots `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacysnapshots. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 92f4e1cc21..11945268fd 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatelegacysnapshotretention. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index e8703da3e8..a994a3b1b3 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -14,11 +14,9 @@ atlas api legacyBackup updateLegacySnapshotSchedule `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 305203aafc..440d2bd94f 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -14,13 +14,11 @@ atlas api legacyBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index 8f99a24cbc..f76a6509a7 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows deferMaintenanceWindow `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-defermaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 1fefe38160..a4c4b730be 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows getMaintenanceWindow `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index c52b6dc311..d23fe8eb34 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows resetMaintenanceWindow `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resetmaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index d80fc48aa4..0ea96dd8a3 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglemaintenanceautodefer. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index e97ae518d1..f12b9c7621 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows updateMaintenanceWindow `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatemaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index 85b2397da2..2ff75c5f27 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -14,11 +14,9 @@ atlas api maintenanceWindows `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index c2fe5c35f8..ec643c1edc 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers addOrganizationRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 8a72066c8c..936a809163 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers addProjectRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 cb9dd60f55..0246d7ca47 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers addProjectUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 77e10ea59e..81db1cd717 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers addUserToTeam `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 c353aaa0e2..64b29f3b14 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers createOrganizationUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 df3eea256f..2d78ee2575 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers createUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 9353b7617c..d8032adc76 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers getOrganizationUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 7086b0d5bf..422cc877d9 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers getProjectUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 95e33ff473..360415f74c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuser. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index ee46363c9a..716a5e25f5 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers getUserByUsername `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyusername. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 574fd8c794..5cace75d1f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers listOrganizationUsers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 0e55f4983d..034220e5ad 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers listProjectUsers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 e979ccc017..9e76d9dc37 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 06f5a581c9..34fd05e1e6 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers removeOrganizationRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 032904bf8d..5f80d485e3 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers removeOrganizationUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 7516f5ec54..d07a313196 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers removeProjectRole `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 0f5524be43..3a88b2d9af 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers removeProjectUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 f06eb51c67..4547a9a4f6 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers removeUserFromTeam `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 076076d8c8..c564b8a697 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -14,11 +14,9 @@ atlas api mongoDbCloudUsers updateOrganizationUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 55ecbf811e..3f5e8e90dd 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -14,13 +14,11 @@ atlas api mongoDbCloudUsers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index c77f902fda..21bdc6900c 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs getAtlasProcess `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlasprocess. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index be603e4910..8ca4e1a2ee 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs getDatabase `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabase. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 3dea598347..6cd09a57e7 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs getDatabaseMeasurements `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabasemeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index fd6406d114..bc0028b8de 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 d9405968eb..ab35961c9b 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-gethostlogs. diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index c449d119e9..530bb45903 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 434741828e..c5027a5e18 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getindexmetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index a1b126fc30..b2dff7d212 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 71bf941ee8..d3c8604664 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs listAtlasProcesses `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlasprocesses. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index a21fbdc163..c89638552e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs listDatabases `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabases. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 5d573e12ef..69cba675be 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskmeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 07d636c8ed..28a3e16b58 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs listDiskPartitions `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskpartitions. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 445bd910f3..9801b4893b 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listindexmetrics. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index af69ba6289..1695da8cca 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -14,11 +14,9 @@ atlas api monitoringAndLogs listMetricTypes `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listmetrictypes. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 9cbfd6e61d..7a4ed28df9 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -14,13 +14,11 @@ atlas api monitoringAndLogs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 7ac0dffb5d..75e4adaa33 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -14,11 +14,9 @@ atlas api networkPeering createPeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index e7377eb3c7..1afd125531 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -14,11 +14,9 @@ atlas api networkPeering createPeeringContainer `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 4e58893d20..01122141b3 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -14,11 +14,9 @@ atlas api networkPeering deletePeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index 056e786689..a4cadcf699 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -14,11 +14,9 @@ atlas api networkPeering deletePeeringContainer `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index d32b018625..9807f5cd4c 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -14,11 +14,9 @@ atlas api networkPeering disablePeering `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablepeering. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index e2ec9d0bd4..3b4b7d1f7e 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -14,11 +14,9 @@ atlas api networkPeering getPeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index a89d2ea4b3..8c993bda16 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -14,11 +14,9 @@ atlas api networkPeering getPeeringContainer `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index a593b441bb..6ad10aad1c 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -14,11 +14,9 @@ atlas api networkPeering listPeeringConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringconnections. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index decb717236..0e31b61106 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainerbycloudprovider. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index c623009660..8271d86a6d 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -14,11 +14,9 @@ atlas api networkPeering listPeeringContainers `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainers. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 13e922964d..57359ff737 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -14,11 +14,9 @@ atlas api networkPeering updatePeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 04100eb3e3..9bc0eea78e 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index d5cca89483..909cc084a0 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -14,11 +14,9 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyconnectviapeeringonlymodeforoneproject. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index b7878bb5b8..c18ba278bc 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -14,11 +14,9 @@ atlas api networkPeering `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index 9a06273ca9..4617498e57 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -14,11 +14,9 @@ atlas api onlineArchive createOnlineArchive `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 976a465dfd..7d07246800 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -14,11 +14,9 @@ atlas api onlineArchive deleteOnlineArchive `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 0711100cae..c06c643bac 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -14,11 +14,9 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadonlinearchivequerylogs. diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 4230dd515e..4913c5c8be 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -14,11 +14,9 @@ atlas api onlineArchive getOnlineArchive `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index b4abe98b8f..94025ee0f9 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -14,11 +14,9 @@ atlas api onlineArchive listOnlineArchives `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listonlinearchives. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 7ee2d25eb3..6a387ba44a 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -14,11 +14,9 @@ atlas api onlineArchive updateOnlineArchive `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index c739fb421f..0e7fbd36ce 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -14,13 +14,11 @@ atlas api onlineArchive `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 132eb265f0..360108b6bc 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganization. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index ff01f3b023..9e1b2feafe 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -14,11 +14,9 @@ atlas api organizations createOrganizationInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 6f9302b5ca..fb91eb69ff 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -14,11 +14,9 @@ atlas api organizations deleteOrganization `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 d7ac442b4a..b48e734d08 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -14,11 +14,9 @@ atlas api organizations deleteOrganizationInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 9811516e45..5a7b2287d1 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -14,11 +14,9 @@ atlas api organizations getOrganization `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganization. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 01ff354097..dad1c7fab1 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -14,11 +14,9 @@ atlas api organizations getOrganizationInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 16c5fa4715..56e2d06086 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -14,11 +14,9 @@ atlas api organizations getOrganizationSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationsettings. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 712d4958cf..67c1414fc5 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -14,11 +14,9 @@ atlas api organizations listOrganizationInvitations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 3e3f11b15e..d7743085a7 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -14,11 +14,9 @@ atlas api organizations listOrganizationProjects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 0f0b1bfc48..44d3b692fa 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -14,11 +14,9 @@ atlas api organizations listOrganizations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizations. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index 28c7198eb1..cc7ef4f679 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -14,11 +14,9 @@ atlas api organizations updateOrganization `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganization. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index b7c45e8b78..fdeed3d05a 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitation. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 036c2de155..97b96ce5d5 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitationbyid. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 3410a673e4..b7df785369 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -14,11 +14,9 @@ atlas api organizations updateOrganizationRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationroles. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index d32d76811c..938c3e176a 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -14,11 +14,9 @@ atlas api organizations updateOrganizationSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationsettings. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 426d78e481..8466aa5ef6 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -14,13 +14,11 @@ atlas api organizations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index 0b625d0c1d..bfacd308af 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor disableSlowOperationThresholding `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disableslowoperationthresholding. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 87f41b582a..aa6b6525be 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor enableSlowOperationThresholding `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-enableslowoperationthresholding. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 6464b01574..714eea5f31 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor getManagedSlowMs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getmanagedslowms. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 72105b3978..923b3da69c 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor getServerlessAutoIndexing `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessautoindexing. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 499ef138ad..98aff293b5 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listClusterSuggestedIndexes `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersuggestedindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index cc028d68f2..a4a8cc4d81 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listDropIndexes `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdropindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index bb96a98c6d..ba37e40c89 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listSchemaAdvice `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listschemaadvice. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 6b095e821e..2f9e4201c3 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listSlowQueries `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowqueries. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index 5742ba241c..011610c5cf 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listSlowQueryNamespaces `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowquerynamespaces. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 2bc1b6aec6..4801247f36 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor listSuggestedIndexes `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsuggestedindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index cb252dbb2d..2d56acc5ca 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor setServerlessAutoIndexing `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setserverlessautoindexing. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 93dc2d2a30..c1187dfdf8 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -14,11 +14,9 @@ atlas api performanceAdvisor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 2f745a5108..a1a2b5a8fb 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api privateEndpointServices createPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 6e75e488eb..083b4ef385 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -14,11 +14,9 @@ atlas api privateEndpointServices createPrivateEndpointService `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 7ad8a48bc8..57635b889c 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 191f5e99e5..7208a88a90 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -14,11 +14,9 @@ atlas api privateEndpointServices deletePrivateEndpointService `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 74b538a96f..1cbaa0057e 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api privateEndpointServices getPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index fb60567143..01ad4be3fd 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -14,11 +14,9 @@ atlas api privateEndpointServices getPrivateEndpointService `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 66db1dacb4..df378d1f1c 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getregionalizedprivateendpointsetting. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index 636deb537b..e526d9318e 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivateendpointservices. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index a6933e4467..99f1f75538 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleregionalizedprivateendpointsetting. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 12389df643..0037af955e 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -14,13 +14,11 @@ atlas api privateEndpointServices `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 0f3f60e1b1..d5793d1532 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys addProjectApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 212bfe9aad..acab8b8b97 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys createApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 92e79c57d4..7f6eb76980 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys createApiKeyAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikeyaccesslist. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 9810efb3fa..17eb818b26 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys createProjectApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index c8233073f9..0fd7e0b8f9 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys deleteApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 0d479a4db9..6861dd4278 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikeyaccesslistentry. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 277b9458e5..6bcfc5bd65 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys getApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 2b01e3bdd7..f61221d3d0 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys getApiKeyAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikeyaccesslist. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 816364e70c..9efc5458dc 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeyaccesslistsentries. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index c84d28e64d..91d3bac2a3 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys listApiKeys `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeys. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index 707971668d..8082b5463c 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys listProjectApiKeys `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectapikeys. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index 466d3df328..b0df2d311d 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys removeProjectApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index cda23503db..1b8fbcfc10 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys updateApiKey `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index d9483d716d..34eee224cf 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikeyroles. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index e6e1889c48..e7f963ed8b 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -14,11 +14,9 @@ atlas api programmaticApiKeys `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index ecdbc8d0c4..d9630ba120 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList createProjectIpAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectipaccesslist. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 3357ce918d..8cc4e2f1fa 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList deleteProjectIpAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectipaccesslist. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index eeee85019d..0e5ea34acb 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList getProjectIpAccessListStatus `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectipaccessliststatus. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index c7adb1aa7f..65e9d2535e 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList getProjectIpList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectiplist. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index 4dd6acc95e..d120d99cd5 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList listProjectIpAccessLists `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectipaccesslists. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 3dbbea9510..37826ecffb 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -14,11 +14,9 @@ atlas api projectIpAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index 56d9bb75ca..182bc943ce 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -14,11 +14,9 @@ atlas api projects addUserToProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addusertoproject. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index d0c9c2109d..ac1f04409b 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -14,11 +14,9 @@ atlas api projects createProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createproject. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index c6f89e9822..6b51c40577 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -14,11 +14,9 @@ atlas api projects createProjectInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index e342ed1554..997fe6bbce 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -14,11 +14,9 @@ atlas api projects deleteProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteproject. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 09571bdd89..b278ce5454 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -14,11 +14,9 @@ atlas api projects deleteProjectInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectinvitation. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index dccea4ca82..faac32558f 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -14,11 +14,9 @@ atlas api projects deleteProjectLimit `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectlimit. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index 816513765d..644c311e1c 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -14,11 +14,9 @@ atlas api projects getProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getproject. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index 986fd568af..e908ca1b3c 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -14,11 +14,9 @@ atlas api projects getProjectByName `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectbyname. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 9c4e9a62ad..516f8130eb 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -14,11 +14,9 @@ atlas api projects getProjectInvitation `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectinvitation. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index e2f473f0e5..0dbaa1007f 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -14,11 +14,9 @@ atlas api projects getProjectLimit `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectlimit. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index 084c32a8ec..d2d76c2682 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -14,11 +14,9 @@ atlas api projects getProjectLtsVersions `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getprojectltsversions. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 584301b6ef..98c61a2a69 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -14,11 +14,9 @@ atlas api projects getProjectSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectsettings. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 5f1870067f..0555601f85 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -14,11 +14,9 @@ atlas api projects listProjectInvitations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectinvitations. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index 98a998e8b8..9101ded3fb 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -14,11 +14,9 @@ atlas api projects listProjectLimits `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectlimits. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index e4288a889e..aa590eab5b 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -14,11 +14,9 @@ atlas api projects listProjects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojects. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index eeeb192aa2..1b17684c2f 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -14,11 +14,9 @@ atlas api projects migrateProjectToAnotherOrg `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-migrateprojecttoanotherorg. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 21410baefb..d6ae34a02c 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -14,11 +14,9 @@ atlas api projects returnAllIpAddresses `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnallipaddresses. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index 0894f899e5..df7aa391e3 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -14,11 +14,9 @@ atlas api projects setProjectLimit `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 d7ff3adbac..7ca4525d06 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateproject. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index c675b0016f..81bf7b07f1 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitation. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 504889e101..7c5a80b5e3 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitationbyid. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index 96f1936fda..3735b9ac22 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -14,11 +14,9 @@ atlas api projects updateProjectRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectroles. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 6c9370899c..e6b41c5e07 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -14,11 +14,9 @@ atlas api projects updateProjectSettings `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectsettings. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index b54857656f..8e2e8501eb 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -14,13 +14,11 @@ atlas api projects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index a382cad6b1..984ba6b066 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -14,11 +14,9 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createpushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index 36fae5bb4e..093f6e2790 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deletepushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index 9bf3336169..c7b6ff3158 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -14,11 +14,9 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getpushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index 7bbc5158ab..c67865b591 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -14,11 +14,9 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updatepushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 4a27e38c73..ddfafcf669 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -14,11 +14,9 @@ atlas api pushBasedLogExport `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index a9b965653b..d9c94ee48a 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies createAtlasResourcePolicy `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 028a39e9f8..be36c1d8a9 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies deleteAtlasResourcePolicy `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deleteatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index 0fa3ae34f9..575ca702cd 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies getAtlasResourcePolicies `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getatlasresourcepolicies. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 51e9173e9c..94d291b92e 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies getAtlasResourcePolicy `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index bf5089b888..51b3e1f8e8 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies getResourcesNonCompliant `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getresourcesnoncompliant. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index 4ad61bd20a..256e130627 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies updateAtlasResourcePolicy `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updateatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index 7ba8f99e3a..d34aca07b8 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -14,11 +14,9 @@ atlas api resourcePolicies validateAtlasResourcePolicy `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-validateatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 02cc4408d0..0b901cbd43 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -14,13 +14,11 @@ atlas api resourcePolicies `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 56ebcc8651..719c820d85 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -14,11 +14,9 @@ atlas api rollingIndex createRollingIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrollingindex. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 1a581a5ba5..dc75943a4f 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -14,11 +14,9 @@ atlas api rollingIndex `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-root-getSystemStatus.txt b/docs/command/atlas-api-root-getSystemStatus.txt index 6d10c7596b..14de0e6164 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -14,11 +14,9 @@ atlas api root getSystemStatus `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getsystemstatus. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 37a33aeef1..9b4e9dea7b 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -14,11 +14,9 @@ atlas api root returnAllControlPlaneIpAddresses `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-returnallcontrolplaneipaddresses. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 4c6c5b27f0..67d2f2e32d 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -14,11 +14,9 @@ atlas api root `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 67f64c70b3..03cd6e46cf 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -14,11 +14,9 @@ atlas api serverlessInstances createServerlessInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 e7d12c5bc8..22b0c71e1c 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -14,11 +14,9 @@ atlas api serverlessInstances deleteServerlessInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 92adc012fe..955b148798 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -14,11 +14,9 @@ atlas api serverlessInstances getServerlessInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 baba101a5c..01c9ed7829 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -14,11 +14,9 @@ atlas api serverlessInstances listServerlessInstances `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 eef0a96c3b..0351e4f0ff 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -14,11 +14,9 @@ atlas api serverlessInstances updateServerlessInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 0acc578a01..36c57106e1 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -14,13 +14,11 @@ atlas api serverlessInstances `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index 1fa54d0780..c5bd612603 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 2eafc81eb2..58a1a9488f 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 b752fa5326..ed322f1146 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 5458d97fbd..1c9e8225f0 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 271b1f379b..a8163382aa 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 d4eeba2c2e..712bc39b39 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -14,11 +14,9 @@ atlas api serverlessPrivateEndpoints `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/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. Options diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index 692bb23a9b..a2600ac471 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts addProjectServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-addprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 9afd325368..4791ce6352 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createProjectServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 189d107acb..036bfef5e0 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createProjectServiceAccountAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 3f125bec5f..29370926b6 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createProjectServiceAccountSecret `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index e5002522f6..3a66468d61 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 408c28deb4..7b6a464945 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createServiceAccountAccessList `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 6652a3ca6f..bdfdf7f3f7 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts createServiceAccountSecret `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 39bed23354..238957ffb0 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 80fe964b04..74ee28ff84 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountaccesslistentry. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index c87625a2d1..afcc6335fa 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index 0cd967f112..cbd4396190 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 66ebbc5923..385906c69d 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountaccesslistentry. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index ff0659415d..fb485459ca 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts deleteServiceAccountSecret `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index 91be5adec1..26d5c7e87e 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts getProjectServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index 05b240a2ee..0d8532b1cb 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts getServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index 4be8dae881..c797f1e5f0 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccountaccesslist. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index b62953d555..983f86171c 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts listProjectServiceAccounts `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccounts. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index a8da2432a2..53b20167f2 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountaccesslist. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 9efba5f59e..92e17db425 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts listServiceAccountProjects `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountprojects. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 46409f1219..163c286179 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts listServiceAccounts `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccounts. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 8c73af6e46..07b2363bf7 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts updateProjectServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updateprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index d549c0eb2e..8496481e24 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts updateServiceAccount `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-updateserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 096b1c2053..3029a8904e 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -14,11 +14,9 @@ atlas api serviceAccounts `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index 5aa1d9e964..fc0cf174cf 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 04e7649d13..bc0a98933c 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -14,11 +14,9 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 ff850c476b..169f534980 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -14,11 +14,9 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 415f404b52..f6bd328115 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -14,13 +14,11 @@ atlas api sharedTierRestoreJobs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index a4b747c39b..3995b61f2c 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -14,11 +14,9 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 46913c68cd..d40ea4ac7b 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -14,11 +14,9 @@ atlas api sharedTierSnapshots getSharedClusterBackup `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 fd92f5e8c2..89db5a6a04 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -14,11 +14,9 @@ atlas api sharedTierSnapshots listSharedClusterBackups `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 ca50d27fac..f17a3e93d3 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -14,13 +14,11 @@ atlas api sharedTierSnapshots `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 9ef66c8123..2198d24ef3 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -14,11 +14,9 @@ atlas api streams acceptVpcPeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-acceptvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index f32a6e17a8..cceb8f3186 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -14,11 +14,9 @@ atlas api streams createPrivateLinkConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 532addf4aa..a1bd998485 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -14,11 +14,9 @@ atlas api streams createStreamConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamconnection. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index ab7b83439c..bc299ac7ff 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -14,11 +14,9 @@ atlas api streams createStreamInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstance. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index c7cc5dc072..fcfdc80a2f 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -14,11 +14,9 @@ atlas api streams createStreamInstanceWithSampleConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstancewithsampleconnections. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 07a7fe084b..efaff9c7d9 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams createStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamprocessor. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 49a6a3c09c..0db1e34da0 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -14,11 +14,9 @@ atlas api streams deletePrivateLinkConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index bd4c057b3e..7f914fed72 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -14,11 +14,9 @@ atlas api streams deleteStreamConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamconnection. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 893db84f44..c558f4e57c 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -14,11 +14,9 @@ atlas api streams deleteStreamInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreaminstance. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 7234af7246..d2774f544f 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams deleteStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamprocessor. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index b8056407d2..582daeac5e 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -14,11 +14,9 @@ atlas api streams deleteVpcPeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-deletevpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 19cf4c3ac6..8b72350d1c 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -14,11 +14,9 @@ atlas api streams downloadStreamTenantAuditLogs `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadstreamtenantauditlogs. diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index a0653f24d6..d97b08149e 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -14,11 +14,9 @@ atlas api streams getAccountDetails `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getaccountdetails. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index dabeb622e3..f5949bac6d 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -14,11 +14,9 @@ atlas api streams getActiveVpcPeeringConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getactivevpcpeeringconnections. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index d537b77670..35dd098ca2 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -14,11 +14,9 @@ atlas api streams getPrivateLinkConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index 724233f422..bd7eeb39c0 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -14,11 +14,9 @@ atlas api streams getStreamConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamconnection. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index cca17e0b09..fcd09fcbca 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -14,11 +14,9 @@ atlas api streams getStreamInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreaminstance. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 993b4bd69e..b904ab586d 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams getStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamprocessor. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index b4ce517d22..4fb9db7a37 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -14,11 +14,9 @@ atlas api streams getVpcPeeringConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-getvpcpeeringconnections. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index c512913700..0710b5d669 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -14,11 +14,9 @@ atlas api streams listPrivateLinkConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivatelinkconnections. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 44d43a2cc8..1ae2166a05 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -14,11 +14,9 @@ atlas api streams listStreamConnections `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamconnections. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 6b3ea03c57..0a332a8461 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -14,11 +14,9 @@ atlas api streams listStreamInstances `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-liststreaminstances. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index ac85eabb44..d93d491baf 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -14,11 +14,9 @@ atlas api streams listStreamProcessors `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamprocessors. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index 94732af3e0..b027103910 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams modifyStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-modifystreamprocessor. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index f0d840f8a5..37d3acb9b6 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -14,11 +14,9 @@ atlas api streams rejectVpcPeeringConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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/api/doc/atlas-admin-api-v2/operation/operation-rejectvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index d8ea939b6b..ceeb684aaf 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams startStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessor. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index bafbdd11eb..2ddc56bc6c 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -14,11 +14,9 @@ atlas api streams startStreamProcessorWith `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessorwith. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 75244c61ee..436b63a575 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -14,11 +14,9 @@ atlas api streams stopStreamProcessor `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-stopstreamprocessor. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index 0e8e594f7b..6d7499e2e5 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -14,11 +14,9 @@ atlas api streams updateStreamConnection `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreamconnection. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 2c222ae131..735582f880 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -14,11 +14,9 @@ atlas api streams updateStreamInstance `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreaminstance. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 34375e7407..86d92c142e 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -14,11 +14,9 @@ atlas api streams `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index 6572fc847a..90aa82355a 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -14,11 +14,9 @@ atlas api teams addAllTeamsToProject `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addallteamstoproject. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 766177a324..6bcf2606d1 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -14,11 +14,9 @@ atlas api teams addTeamUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 1107c6a1a9..f1a472ad6d 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -14,11 +14,9 @@ atlas api teams createTeam `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createteam. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index f573318906..258aba48bd 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteteam. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 555753bd48..bf13569fee 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -14,11 +14,9 @@ atlas api teams getTeamById `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyid. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 887d3f8fb3..8ec4b30857 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -14,11 +14,9 @@ atlas api teams getTeamByName `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyname. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index ba854a031d..93405a80d4 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -14,11 +14,9 @@ atlas api teams listOrganizationTeams `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationteams. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 9b527296a3..612203cb16 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectteams. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 1c01d2aceb..052a7ffb46 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectteam. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index 982d0cb1e5..f9cee4d3bb 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -14,11 +14,9 @@ atlas api teams removeTeamUser `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 322dc1ce5b..c2a48f8b66 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -14,11 +14,9 @@ atlas api teams renameTeam `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-renameteam. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index a4ce3b7312..b1e50daced 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -14,11 +14,9 @@ atlas api teams updateTeamRoles `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateteamroles. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 8a585a0316..551d4f1392 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -14,13 +14,11 @@ atlas api 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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index 9e7d1ebfc7..b0bdfe85ff 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createthirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 9040c64737..dd2928cbe9 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletethirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index 27e6a4d9b4..886ece2689 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getthirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 66e638df78..36a8ae815b 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listthirdpartyintegrations. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 44d7980256..7f38b63612 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatethirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index 64054ce4ff..d2971d8f61 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -14,11 +14,9 @@ atlas api thirdPartyIntegrations `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index 914180ba38..ad9516b8a6 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -14,11 +14,9 @@ atlas api x509Authentication createDatabaseUserCertificate `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 ac30276b4f..bb5656a513 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -14,11 +14,9 @@ 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. -Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablecustomermanagedx509. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 43d73d7942..8450c3c373 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -14,11 +14,9 @@ atlas api x509Authentication listDatabaseUserCertificates `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusercertificates. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index 5df3c92d4f..a18b96f914 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -14,11 +14,9 @@ atlas api x509Authentication `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). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. Options diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index a42f144379..441d32e516 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -14,11 +14,6 @@ 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. For more information on diff --git a/docs/command/atlas-auditing-describe.txt b/docs/command/atlas-auditing-describe.txt index 62d2c79cba..d5e7d1b59a 100644 --- a/docs/command/atlas-auditing-describe.txt +++ b/docs/command/atlas-auditing-describe.txt @@ -14,11 +14,6 @@ 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 8a5fbc5c27..9db1566290 100644 --- a/docs/command/atlas-auditing-update.txt +++ b/docs/command/atlas-auditing-update.txt @@ -14,11 +14,6 @@ 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 47fecf31e8..9a2b9b3290 100644 --- a/docs/command/atlas-auditing.txt +++ b/docs/command/atlas-auditing.txt @@ -14,13 +14,6 @@ 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 3076bc3039..689d867fa7 100644 --- a/docs/command/atlas-auth-login.txt +++ b/docs/command/atlas-auth-login.txt @@ -14,13 +14,6 @@ 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 279b985afd..26bae6e33e 100644 --- a/docs/command/atlas-auth-logout.txt +++ b/docs/command/atlas-auth-logout.txt @@ -14,13 +14,6 @@ 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 10685a269b..e61b24277b 100644 --- a/docs/command/atlas-auth-register.txt +++ b/docs/command/atlas-auth-register.txt @@ -14,13 +14,6 @@ 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 69303e5542..35aabc095e 100644 --- a/docs/command/atlas-auth-whoami.txt +++ b/docs/command/atlas-auth-whoami.txt @@ -14,13 +14,6 @@ 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 ad0e97c08a..eef0de5289 100644 --- a/docs/command/atlas-auth.txt +++ b/docs/command/atlas-auth.txt @@ -14,13 +14,6 @@ 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 8d8b80a501..37e4a12583 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -14,13 +14,6 @@ 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 efd9fbfb60..3887c8ab05 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -14,13 +14,6 @@ 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 fa3c107f77..4a57b44306 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -14,13 +14,6 @@ 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 187dab9daf..453824e993 100644 --- a/docs/command/atlas-backups-compliancePolicy-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-describe.txt @@ -14,13 +14,6 @@ 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 b2f47f4806..3050689c0c 100644 --- a/docs/command/atlas-backups-compliancePolicy-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-enable.txt @@ -14,13 +14,6 @@ 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 9123d118e4..5cf0a602be 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -14,13 +14,6 @@ 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 c8900d81f6..ee1b5b3597 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -14,13 +14,6 @@ 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 9cf4027dce..8c4593ff95 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -14,13 +14,6 @@ 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 39d59bcb53..e304ec1e16 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -14,13 +14,6 @@ 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 e8dac4104b..ef796859c2 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -14,13 +14,6 @@ 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 7c87c85905..67682b6086 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -14,13 +14,6 @@ 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 75dfa6dd2f..ad02d1aad4 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -14,13 +14,6 @@ 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 ff3f575607..574787f69b 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -14,13 +14,6 @@ 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 0b78d79dcf..5380a584ad 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -14,13 +14,6 @@ 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 7da30510a7..4aad7eae1c 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -14,13 +14,6 @@ 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 bc337f85fd..302052d88a 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -14,13 +14,6 @@ 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 2920352a31..f7e60ac25f 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -14,13 +14,6 @@ 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 fe54c8e26f..9d2376fa43 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -14,13 +14,6 @@ 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 0777a61367..40b7bd48d9 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies.txt @@ -14,13 +14,6 @@ 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 bfeaa88463..ab2195d9bd 100644 --- a/docs/command/atlas-backups-compliancePolicy-setup.txt +++ b/docs/command/atlas-backups-compliancePolicy-setup.txt @@ -14,13 +14,6 @@ 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 ca60f97b86..b78e1b53db 100644 --- a/docs/command/atlas-backups-compliancePolicy.txt +++ b/docs/command/atlas-backups-compliancePolicy.txt @@ -14,13 +14,6 @@ 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 59190cfaa8..484f78bca4 100644 --- a/docs/command/atlas-backups-exports-buckets-create.txt +++ b/docs/command/atlas-backups-exports-buckets-create.txt @@ -14,11 +14,6 @@ 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 8758512636..2d46d90e33 100644 --- a/docs/command/atlas-backups-exports-buckets-delete.txt +++ b/docs/command/atlas-backups-exports-buckets-delete.txt @@ -14,11 +14,6 @@ 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 b0ff2017eb..3d32a61e50 100644 --- a/docs/command/atlas-backups-exports-buckets-describe.txt +++ b/docs/command/atlas-backups-exports-buckets-describe.txt @@ -14,11 +14,6 @@ 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 16b0e1d303..b899715280 100644 --- a/docs/command/atlas-backups-exports-buckets-list.txt +++ b/docs/command/atlas-backups-exports-buckets-list.txt @@ -14,11 +14,6 @@ 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 bbbceb9282..c72ae83931 100644 --- a/docs/command/atlas-backups-exports-buckets.txt +++ b/docs/command/atlas-backups-exports-buckets.txt @@ -14,13 +14,6 @@ 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 d025c0f046..94ce5ccd4e 100644 --- a/docs/command/atlas-backups-exports-jobs-create.txt +++ b/docs/command/atlas-backups-exports-jobs-create.txt @@ -14,11 +14,6 @@ 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 aa5ab5319a..01888b547d 100644 --- a/docs/command/atlas-backups-exports-jobs-describe.txt +++ b/docs/command/atlas-backups-exports-jobs-describe.txt @@ -14,11 +14,6 @@ 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 8da9bbacbd..7471289e32 100644 --- a/docs/command/atlas-backups-exports-jobs-list.txt +++ b/docs/command/atlas-backups-exports-jobs-list.txt @@ -14,11 +14,6 @@ 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 317270b0c2..c65501c266 100644 --- a/docs/command/atlas-backups-exports-jobs-watch.txt +++ b/docs/command/atlas-backups-exports-jobs-watch.txt @@ -14,11 +14,6 @@ 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 15fedcab09..18641dd17e 100644 --- a/docs/command/atlas-backups-exports-jobs.txt +++ b/docs/command/atlas-backups-exports-jobs.txt @@ -14,13 +14,6 @@ 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 8053b20f0d..1038c8c892 100644 --- a/docs/command/atlas-backups-exports.txt +++ b/docs/command/atlas-backups-exports.txt @@ -14,13 +14,6 @@ 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 3108c97b8a..b79ffee197 100644 --- a/docs/command/atlas-backups-restores-describe.txt +++ b/docs/command/atlas-backups-restores-describe.txt @@ -14,11 +14,6 @@ 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 11a1b79100..dbbd1f4da7 100644 --- a/docs/command/atlas-backups-restores-list.txt +++ b/docs/command/atlas-backups-restores-list.txt @@ -14,11 +14,6 @@ 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 8879525a70..5013a092c7 100644 --- a/docs/command/atlas-backups-restores-start.txt +++ b/docs/command/atlas-backups-restores-start.txt @@ -14,11 +14,6 @@ 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 6debf82c71..c0f540348f 100644 --- a/docs/command/atlas-backups-restores-watch.txt +++ b/docs/command/atlas-backups-restores-watch.txt @@ -14,11 +14,6 @@ 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 fda2b83f4d..5959488c5b 100644 --- a/docs/command/atlas-backups-restores.txt +++ b/docs/command/atlas-backups-restores.txt @@ -14,13 +14,6 @@ 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 7b9a5ac42a..b78fc1f408 100644 --- a/docs/command/atlas-backups-schedule-delete.txt +++ b/docs/command/atlas-backups-schedule-delete.txt @@ -14,11 +14,6 @@ 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 0853985028..bc59d3470b 100644 --- a/docs/command/atlas-backups-schedule-describe.txt +++ b/docs/command/atlas-backups-schedule-describe.txt @@ -14,11 +14,6 @@ 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 86211468e0..aa99e70631 100644 --- a/docs/command/atlas-backups-schedule-update.txt +++ b/docs/command/atlas-backups-schedule-update.txt @@ -14,11 +14,6 @@ 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 8af337ba2f..3b3382244d 100644 --- a/docs/command/atlas-backups-schedule.txt +++ b/docs/command/atlas-backups-schedule.txt @@ -14,13 +14,6 @@ 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 4a2f813133..a9c24f0a57 100644 --- a/docs/command/atlas-backups-snapshots-create.txt +++ b/docs/command/atlas-backups-snapshots-create.txt @@ -14,11 +14,6 @@ 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 05c247aaa9..99e44b55fc 100644 --- a/docs/command/atlas-backups-snapshots-delete.txt +++ b/docs/command/atlas-backups-snapshots-delete.txt @@ -14,11 +14,6 @@ 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 794c70b856..20bcc9f6e1 100644 --- a/docs/command/atlas-backups-snapshots-describe.txt +++ b/docs/command/atlas-backups-snapshots-describe.txt @@ -14,11 +14,6 @@ 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 0d18b8aa06..11b570f992 100644 --- a/docs/command/atlas-backups-snapshots-download.txt +++ b/docs/command/atlas-backups-snapshots-download.txt @@ -14,11 +14,6 @@ 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 ab98629bb9..4fee8008ea 100644 --- a/docs/command/atlas-backups-snapshots-list.txt +++ b/docs/command/atlas-backups-snapshots-list.txt @@ -14,11 +14,6 @@ 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 65a3a2e518..f17ed235fc 100644 --- a/docs/command/atlas-backups-snapshots-watch.txt +++ b/docs/command/atlas-backups-snapshots-watch.txt @@ -14,11 +14,6 @@ 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 8ccde5d6f5..028c6c021b 100644 --- a/docs/command/atlas-backups-snapshots.txt +++ b/docs/command/atlas-backups-snapshots.txt @@ -14,13 +14,6 @@ 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 b02fa017ff..c04fe26d41 100644 --- a/docs/command/atlas-backups.txt +++ b/docs/command/atlas-backups.txt @@ -14,13 +14,6 @@ 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 9e67b1db57..63807f8d41 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -14,13 +14,6 @@ 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 daa56658dd..d9d9cc95a5 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -14,11 +14,6 @@ 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 5b891c2c41..cdb6f3e25b 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -14,11 +14,6 @@ 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 136a9d0d90..87be4ff42e 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws.txt @@ -14,13 +14,6 @@ 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 e21673a151..f547b542a0 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-list.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-list.txt @@ -14,11 +14,6 @@ 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 8a932a5bf3..a0d5c04fa9 100644 --- a/docs/command/atlas-cloudProviders-accessRoles.txt +++ b/docs/command/atlas-cloudProviders-accessRoles.txt @@ -14,13 +14,6 @@ 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 36918900f4..397bdf243d 100644 --- a/docs/command/atlas-cloudProviders.txt +++ b/docs/command/atlas-cloudProviders.txt @@ -14,13 +14,6 @@ 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 a799377a6b..da40aab20e 100644 --- a/docs/command/atlas-clusters-advancedSettings-describe.txt +++ b/docs/command/atlas-clusters-advancedSettings-describe.txt @@ -14,11 +14,6 @@ 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 39f245aa8f..5017e010ae 100644 --- a/docs/command/atlas-clusters-advancedSettings-update.txt +++ b/docs/command/atlas-clusters-advancedSettings-update.txt @@ -14,11 +14,6 @@ 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 e88b76fde2..206c7620db 100644 --- a/docs/command/atlas-clusters-advancedSettings.txt +++ b/docs/command/atlas-clusters-advancedSettings.txt @@ -14,13 +14,6 @@ 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 6443c0e954..e0adf92e91 100644 --- a/docs/command/atlas-clusters-availableRegions-list.txt +++ b/docs/command/atlas-clusters-availableRegions-list.txt @@ -14,13 +14,6 @@ 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 659e4cd7cf..56a43e7f4a 100644 --- a/docs/command/atlas-clusters-availableRegions.txt +++ b/docs/command/atlas-clusters-availableRegions.txt @@ -14,13 +14,6 @@ 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 434c26ca79..92b25f762c 100644 --- a/docs/command/atlas-clusters-connectionStrings-describe.txt +++ b/docs/command/atlas-clusters-connectionStrings-describe.txt @@ -14,11 +14,6 @@ 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 beaeeb8c14..0b206d8b56 100644 --- a/docs/command/atlas-clusters-connectionStrings.txt +++ b/docs/command/atlas-clusters-connectionStrings.txt @@ -14,13 +14,6 @@ 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 7bfb785226..f378e50ae0 100644 --- a/docs/command/atlas-clusters-create.txt +++ b/docs/command/atlas-clusters-create.txt @@ -14,11 +14,6 @@ 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 ea1199aa2c..cf9404e96d 100644 --- a/docs/command/atlas-clusters-delete.txt +++ b/docs/command/atlas-clusters-delete.txt @@ -14,11 +14,6 @@ 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 edecfae8ae..00efe4c4b4 100644 --- a/docs/command/atlas-clusters-describe.txt +++ b/docs/command/atlas-clusters-describe.txt @@ -14,11 +14,6 @@ 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 cac047205c..8d96a5dee8 100644 --- a/docs/command/atlas-clusters-failover.txt +++ b/docs/command/atlas-clusters-failover.txt @@ -14,11 +14,6 @@ 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 3b73e401e9..b0ab8cec36 100644 --- a/docs/command/atlas-clusters-indexes-create.txt +++ b/docs/command/atlas-clusters-indexes-create.txt @@ -14,11 +14,6 @@ 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 0b908df2ab..2fb07225f6 100644 --- a/docs/command/atlas-clusters-indexes.txt +++ b/docs/command/atlas-clusters-indexes.txt @@ -14,13 +14,6 @@ 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 77d70a3d97..35d0134fd8 100644 --- a/docs/command/atlas-clusters-list.txt +++ b/docs/command/atlas-clusters-list.txt @@ -14,11 +14,6 @@ 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 b7d4e6b1cb..807caab592 100644 --- a/docs/command/atlas-clusters-onlineArchives-create.txt +++ b/docs/command/atlas-clusters-onlineArchives-create.txt @@ -14,11 +14,6 @@ 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 1e270f0d5c..1565262de1 100644 --- a/docs/command/atlas-clusters-onlineArchives-delete.txt +++ b/docs/command/atlas-clusters-onlineArchives-delete.txt @@ -14,11 +14,6 @@ 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 b367a735dc..61d98b1ab0 100644 --- a/docs/command/atlas-clusters-onlineArchives-describe.txt +++ b/docs/command/atlas-clusters-onlineArchives-describe.txt @@ -14,11 +14,6 @@ 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 c431fd5954..31303c36d0 100644 --- a/docs/command/atlas-clusters-onlineArchives-list.txt +++ b/docs/command/atlas-clusters-onlineArchives-list.txt @@ -14,11 +14,6 @@ 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 20b2332fe3..996bf97623 100644 --- a/docs/command/atlas-clusters-onlineArchives-pause.txt +++ b/docs/command/atlas-clusters-onlineArchives-pause.txt @@ -14,11 +14,6 @@ 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 edfaca7889..9b9f22efdd 100644 --- a/docs/command/atlas-clusters-onlineArchives-start.txt +++ b/docs/command/atlas-clusters-onlineArchives-start.txt @@ -14,11 +14,6 @@ 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 6e147f2b89..53ee303d8d 100644 --- a/docs/command/atlas-clusters-onlineArchives-update.txt +++ b/docs/command/atlas-clusters-onlineArchives-update.txt @@ -14,11 +14,6 @@ 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 0978c01ce4..dd7d016207 100644 --- a/docs/command/atlas-clusters-onlineArchives-watch.txt +++ b/docs/command/atlas-clusters-onlineArchives-watch.txt @@ -14,11 +14,6 @@ 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 bd566ac194..b689acf59a 100644 --- a/docs/command/atlas-clusters-onlineArchives.txt +++ b/docs/command/atlas-clusters-onlineArchives.txt @@ -14,13 +14,6 @@ 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 97e06f64d7..9abdbc5ba5 100644 --- a/docs/command/atlas-clusters-pause.txt +++ b/docs/command/atlas-clusters-pause.txt @@ -14,11 +14,6 @@ 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 29b6c531cf..4582679f53 100644 --- a/docs/command/atlas-clusters-sampleData-describe.txt +++ b/docs/command/atlas-clusters-sampleData-describe.txt @@ -14,11 +14,6 @@ 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 bec2a5b68d..89f96848c5 100644 --- a/docs/command/atlas-clusters-sampleData-load.txt +++ b/docs/command/atlas-clusters-sampleData-load.txt @@ -14,11 +14,6 @@ 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 5546b53d64..6999b01897 100644 --- a/docs/command/atlas-clusters-sampleData-watch.txt +++ b/docs/command/atlas-clusters-sampleData-watch.txt @@ -14,11 +14,6 @@ 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 1b8dedeb94..60fb597813 100644 --- a/docs/command/atlas-clusters-sampleData.txt +++ b/docs/command/atlas-clusters-sampleData.txt @@ -14,11 +14,6 @@ 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 b33966e2d9..798abf7b66 100644 --- a/docs/command/atlas-clusters-search-indexes-create.txt +++ b/docs/command/atlas-clusters-search-indexes-create.txt @@ -14,11 +14,6 @@ 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 f25f528d2e..7541ce1050 100644 --- a/docs/command/atlas-clusters-search-indexes-delete.txt +++ b/docs/command/atlas-clusters-search-indexes-delete.txt @@ -14,11 +14,6 @@ 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 d517a5a841..eef63fa825 100644 --- a/docs/command/atlas-clusters-search-indexes-describe.txt +++ b/docs/command/atlas-clusters-search-indexes-describe.txt @@ -14,11 +14,6 @@ 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 b0f4e58a67..e17eb4d23a 100644 --- a/docs/command/atlas-clusters-search-indexes-list.txt +++ b/docs/command/atlas-clusters-search-indexes-list.txt @@ -14,11 +14,6 @@ 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 e3edfec242..87c5a17dd3 100644 --- a/docs/command/atlas-clusters-search-indexes-update.txt +++ b/docs/command/atlas-clusters-search-indexes-update.txt @@ -14,11 +14,6 @@ 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 df172b1461..160e679678 100644 --- a/docs/command/atlas-clusters-search-indexes.txt +++ b/docs/command/atlas-clusters-search-indexes.txt @@ -14,13 +14,6 @@ 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 51cf4881d6..b60cc0fa92 100644 --- a/docs/command/atlas-clusters-search-nodes-create.txt +++ b/docs/command/atlas-clusters-search-nodes-create.txt @@ -14,11 +14,6 @@ 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 5666a2097b..fff9832631 100644 --- a/docs/command/atlas-clusters-search-nodes-delete.txt +++ b/docs/command/atlas-clusters-search-nodes-delete.txt @@ -14,11 +14,6 @@ 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 4c2c81751b..c0d3460121 100644 --- a/docs/command/atlas-clusters-search-nodes-list.txt +++ b/docs/command/atlas-clusters-search-nodes-list.txt @@ -14,11 +14,6 @@ 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 4d1f31d834..bab41d6284 100644 --- a/docs/command/atlas-clusters-search-nodes-update.txt +++ b/docs/command/atlas-clusters-search-nodes-update.txt @@ -14,11 +14,6 @@ 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 15c2497387..958a089711 100644 --- a/docs/command/atlas-clusters-search-nodes.txt +++ b/docs/command/atlas-clusters-search-nodes.txt @@ -14,13 +14,6 @@ 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 0cf13ee0ae..d8ffd2b0ba 100644 --- a/docs/command/atlas-clusters-search.txt +++ b/docs/command/atlas-clusters-search.txt @@ -14,13 +14,6 @@ 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 64b76a356c..ab3d7c4c23 100644 --- a/docs/command/atlas-clusters-start.txt +++ b/docs/command/atlas-clusters-start.txt @@ -14,11 +14,6 @@ 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 6660fcb3a1..d47764f86f 100644 --- a/docs/command/atlas-clusters-update.txt +++ b/docs/command/atlas-clusters-update.txt @@ -14,11 +14,6 @@ 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 5e8a33089a..59b913b58a 100644 --- a/docs/command/atlas-clusters-upgrade.txt +++ b/docs/command/atlas-clusters-upgrade.txt @@ -14,11 +14,6 @@ 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 d5fd242dd8..9370e54689 100644 --- a/docs/command/atlas-clusters-watch.txt +++ b/docs/command/atlas-clusters-watch.txt @@ -14,11 +14,6 @@ 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 898080279d..5f49f0d466 100644 --- a/docs/command/atlas-clusters.txt +++ b/docs/command/atlas-clusters.txt @@ -14,11 +14,6 @@ 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 88493a2445..cdb18085f7 100644 --- a/docs/command/atlas-completion-fish.txt +++ b/docs/command/atlas-completion-fish.txt @@ -14,11 +14,6 @@ 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 92864e69de..4ec9d22b11 100644 --- a/docs/command/atlas-completion-powershell.txt +++ b/docs/command/atlas-completion-powershell.txt @@ -14,11 +14,6 @@ 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 39ddc5fbaa..f5052fa504 100644 --- a/docs/command/atlas-completion-zsh.txt +++ b/docs/command/atlas-completion-zsh.txt @@ -14,11 +14,6 @@ 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 8ae0cc0b34..57d74af29c 100644 --- a/docs/command/atlas-completion.txt +++ b/docs/command/atlas-completion.txt @@ -14,11 +14,6 @@ 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 37d961a176..767cc09906 100644 --- a/docs/command/atlas-config-delete.txt +++ b/docs/command/atlas-config-delete.txt @@ -14,13 +14,6 @@ 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 b1911dcf9b..56359f1812 100644 --- a/docs/command/atlas-config-describe.txt +++ b/docs/command/atlas-config-describe.txt @@ -14,13 +14,6 @@ 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 ec1478b022..3f79872c73 100644 --- a/docs/command/atlas-config-edit.txt +++ b/docs/command/atlas-config-edit.txt @@ -14,11 +14,6 @@ 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 8f19185975..5869b38318 100644 --- a/docs/command/atlas-config-init.txt +++ b/docs/command/atlas-config-init.txt @@ -14,13 +14,6 @@ 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 f4d337930e..36cee08ac7 100644 --- a/docs/command/atlas-config-list.txt +++ b/docs/command/atlas-config-list.txt @@ -14,11 +14,6 @@ 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 f0ab398ac8..cd801e52d7 100644 --- a/docs/command/atlas-config-rename.txt +++ b/docs/command/atlas-config-rename.txt @@ -14,13 +14,6 @@ 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 b2bf1ec57c..dd1be889b6 100644 --- a/docs/command/atlas-config-set.txt +++ b/docs/command/atlas-config-set.txt @@ -14,13 +14,6 @@ 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 14f6b198bb..407faf6a3a 100644 --- a/docs/command/atlas-config.txt +++ b/docs/command/atlas-config.txt @@ -14,11 +14,6 @@ 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 1e5ab98d89..9b8a215906 100644 --- a/docs/command/atlas-customDbRoles-create.txt +++ b/docs/command/atlas-customDbRoles-create.txt @@ -14,11 +14,6 @@ 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 eba3c574de..15ac1aa8a1 100644 --- a/docs/command/atlas-customDbRoles-delete.txt +++ b/docs/command/atlas-customDbRoles-delete.txt @@ -14,11 +14,6 @@ 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 10cae21512..fc55e02673 100644 --- a/docs/command/atlas-customDbRoles-describe.txt +++ b/docs/command/atlas-customDbRoles-describe.txt @@ -14,11 +14,6 @@ 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 8e256bf775..68e8f8d518 100644 --- a/docs/command/atlas-customDbRoles-list.txt +++ b/docs/command/atlas-customDbRoles-list.txt @@ -14,11 +14,6 @@ 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 619ca0f433..eb665640dc 100644 --- a/docs/command/atlas-customDbRoles-update.txt +++ b/docs/command/atlas-customDbRoles-update.txt @@ -14,11 +14,6 @@ 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 ec12e4f561..674eaa626a 100644 --- a/docs/command/atlas-customDbRoles.txt +++ b/docs/command/atlas-customDbRoles.txt @@ -14,13 +14,6 @@ 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 d25889d6c5..f19e00caa6 100644 --- a/docs/command/atlas-customDns-aws-describe.txt +++ b/docs/command/atlas-customDns-aws-describe.txt @@ -14,11 +14,6 @@ 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 998a037f19..fe8931480d 100644 --- a/docs/command/atlas-customDns-aws-disable.txt +++ b/docs/command/atlas-customDns-aws-disable.txt @@ -14,11 +14,6 @@ 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 e42dec039e..7ebf795a8b 100644 --- a/docs/command/atlas-customDns-aws-enable.txt +++ b/docs/command/atlas-customDns-aws-enable.txt @@ -14,11 +14,6 @@ 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 7c0ae6f4c5..2b385960ad 100644 --- a/docs/command/atlas-customDns-aws.txt +++ b/docs/command/atlas-customDns-aws.txt @@ -14,13 +14,6 @@ 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 a1acf0bf97..a613a48d18 100644 --- a/docs/command/atlas-customDns.txt +++ b/docs/command/atlas-customDns.txt @@ -14,13 +14,6 @@ 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 d5de6d016c..cb56350eae 100644 --- a/docs/command/atlas-dataFederation-create.txt +++ b/docs/command/atlas-dataFederation-create.txt @@ -14,11 +14,6 @@ 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 46080bd311..e382667aa3 100644 --- a/docs/command/atlas-dataFederation-delete.txt +++ b/docs/command/atlas-dataFederation-delete.txt @@ -14,11 +14,6 @@ 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 ec1c187e05..5499f34860 100644 --- a/docs/command/atlas-dataFederation-describe.txt +++ b/docs/command/atlas-dataFederation-describe.txt @@ -14,11 +14,6 @@ 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 e61d582ca0..59c6ee9682 100644 --- a/docs/command/atlas-dataFederation-list.txt +++ b/docs/command/atlas-dataFederation-list.txt @@ -14,11 +14,6 @@ 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 6a780c1390..708beaf639 100644 --- a/docs/command/atlas-dataFederation-logs.txt +++ b/docs/command/atlas-dataFederation-logs.txt @@ -14,11 +14,6 @@ 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 3ce4302f69..92cbbefc52 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-create.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-create.txt @@ -14,11 +14,6 @@ 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 19b005a764..b120e76382 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -14,11 +14,6 @@ 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 fb88777c7a..f6c4a32295 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -14,11 +14,6 @@ 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 975143246d..11c74755fa 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-list.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-list.txt @@ -14,11 +14,6 @@ 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 8648735cde..2bb92609a9 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints.txt @@ -14,13 +14,6 @@ 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 32d7ac2672..eaa5f1f2cf 100644 --- a/docs/command/atlas-dataFederation-queryLimits-create.txt +++ b/docs/command/atlas-dataFederation-queryLimits-create.txt @@ -14,11 +14,6 @@ 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 dcb374aaaa..3291c783d6 100644 --- a/docs/command/atlas-dataFederation-queryLimits-delete.txt +++ b/docs/command/atlas-dataFederation-queryLimits-delete.txt @@ -14,11 +14,6 @@ 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 ccf46e5925..63f1b1b213 100644 --- a/docs/command/atlas-dataFederation-queryLimits-describe.txt +++ b/docs/command/atlas-dataFederation-queryLimits-describe.txt @@ -14,11 +14,6 @@ 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 8408b8bf69..9f30232375 100644 --- a/docs/command/atlas-dataFederation-queryLimits-list.txt +++ b/docs/command/atlas-dataFederation-queryLimits-list.txt @@ -14,11 +14,6 @@ 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 16bec56f2e..9667d5ede8 100644 --- a/docs/command/atlas-dataFederation-queryLimits.txt +++ b/docs/command/atlas-dataFederation-queryLimits.txt @@ -14,13 +14,6 @@ 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 3600b5c81f..9efe96d462 100644 --- a/docs/command/atlas-dataFederation-update.txt +++ b/docs/command/atlas-dataFederation-update.txt @@ -14,11 +14,6 @@ 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 585465dd3e..f548e43470 100644 --- a/docs/command/atlas-dataFederation.txt +++ b/docs/command/atlas-dataFederation.txt @@ -14,13 +14,6 @@ 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 283c7a416c..a5771b97af 100644 --- a/docs/command/atlas-dbusers-certs-create.txt +++ b/docs/command/atlas-dbusers-certs-create.txt @@ -14,11 +14,6 @@ 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 d3d5556f54..fd6999647e 100644 --- a/docs/command/atlas-dbusers-certs-list.txt +++ b/docs/command/atlas-dbusers-certs-list.txt @@ -14,11 +14,6 @@ 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 fa3cea6d57..e5cf674a70 100644 --- a/docs/command/atlas-dbusers-certs.txt +++ b/docs/command/atlas-dbusers-certs.txt @@ -14,13 +14,6 @@ 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 36cc6c8686..53cf35d052 100644 --- a/docs/command/atlas-dbusers-create.txt +++ b/docs/command/atlas-dbusers-create.txt @@ -14,11 +14,6 @@ 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 07b6d47976..78e7aec17f 100644 --- a/docs/command/atlas-dbusers-delete.txt +++ b/docs/command/atlas-dbusers-delete.txt @@ -14,11 +14,6 @@ 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 0eda7d3385..275db941a8 100644 --- a/docs/command/atlas-dbusers-describe.txt +++ b/docs/command/atlas-dbusers-describe.txt @@ -14,11 +14,6 @@ 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 71f5832561..cebb33b69f 100644 --- a/docs/command/atlas-dbusers-list.txt +++ b/docs/command/atlas-dbusers-list.txt @@ -14,11 +14,6 @@ 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 bd178e4ab3..55583100e8 100644 --- a/docs/command/atlas-dbusers-update.txt +++ b/docs/command/atlas-dbusers-update.txt @@ -14,11 +14,6 @@ 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 1b8e01d1a5..bf2938b99d 100644 --- a/docs/command/atlas-dbusers.txt +++ b/docs/command/atlas-dbusers.txt @@ -14,11 +14,6 @@ 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 5b1d66b10b..ba7a01e12e 100644 --- a/docs/command/atlas-deployments-connect.txt +++ b/docs/command/atlas-deployments-connect.txt @@ -14,13 +14,6 @@ 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 e6f063c2c6..7da47cbad1 100644 --- a/docs/command/atlas-deployments-delete.txt +++ b/docs/command/atlas-deployments-delete.txt @@ -14,11 +14,6 @@ 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 c1f02a3a97..6cd4592154 100644 --- a/docs/command/atlas-deployments-list.txt +++ b/docs/command/atlas-deployments-list.txt @@ -14,13 +14,6 @@ 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 db3399045b..9d4c889676 100644 --- a/docs/command/atlas-deployments-logs.txt +++ b/docs/command/atlas-deployments-logs.txt @@ -14,13 +14,6 @@ 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 5d5f05cab9..0508178d28 100644 --- a/docs/command/atlas-deployments-pause.txt +++ b/docs/command/atlas-deployments-pause.txt @@ -14,13 +14,6 @@ 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 692d8f40f5..6948f1a187 100644 --- a/docs/command/atlas-deployments-search-indexes-create.txt +++ b/docs/command/atlas-deployments-search-indexes-create.txt @@ -14,13 +14,6 @@ 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 51de8a1b6f..49f5287e6b 100644 --- a/docs/command/atlas-deployments-search-indexes-delete.txt +++ b/docs/command/atlas-deployments-search-indexes-delete.txt @@ -14,13 +14,6 @@ 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 adf5bc3f48..fef7fb2e84 100644 --- a/docs/command/atlas-deployments-search-indexes-describe.txt +++ b/docs/command/atlas-deployments-search-indexes-describe.txt @@ -14,13 +14,6 @@ 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 0123dd23c9..75ba7080a4 100644 --- a/docs/command/atlas-deployments-search-indexes-list.txt +++ b/docs/command/atlas-deployments-search-indexes-list.txt @@ -14,13 +14,6 @@ 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 31457d7c0e..e585c945e0 100644 --- a/docs/command/atlas-deployments-search-indexes.txt +++ b/docs/command/atlas-deployments-search-indexes.txt @@ -14,13 +14,6 @@ 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 bcfca8d071..dc0b73c8b1 100644 --- a/docs/command/atlas-deployments-search.txt +++ b/docs/command/atlas-deployments-search.txt @@ -14,13 +14,6 @@ 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 d15f7eeabf..e77f813dc7 100644 --- a/docs/command/atlas-deployments-setup.txt +++ b/docs/command/atlas-deployments-setup.txt @@ -14,11 +14,6 @@ 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 377cade0d4..803e81ada9 100644 --- a/docs/command/atlas-deployments-start.txt +++ b/docs/command/atlas-deployments-start.txt @@ -14,11 +14,6 @@ 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 e6975458d4..fea6b69c08 100644 --- a/docs/command/atlas-deployments.txt +++ b/docs/command/atlas-deployments.txt @@ -14,13 +14,6 @@ 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 7a409fdc4b..86fc6039d1 100644 --- a/docs/command/atlas-events-organizations-list.txt +++ b/docs/command/atlas-events-organizations-list.txt @@ -14,13 +14,6 @@ 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 b9d1601018..aca25de921 100644 --- a/docs/command/atlas-events-organizations.txt +++ b/docs/command/atlas-events-organizations.txt @@ -14,11 +14,6 @@ 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 e117c106c5..06ea1ee489 100644 --- a/docs/command/atlas-events-projects-list.txt +++ b/docs/command/atlas-events-projects-list.txt @@ -14,13 +14,6 @@ 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 8ac9f391a7..1eeef0b881 100644 --- a/docs/command/atlas-events-projects.txt +++ b/docs/command/atlas-events-projects.txt @@ -14,11 +14,6 @@ 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 09d6aea497..83e44e0a93 100644 --- a/docs/command/atlas-events.txt +++ b/docs/command/atlas-events.txt @@ -14,13 +14,6 @@ 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 4cb091bc72..849ea4f68f 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -14,13 +14,6 @@ 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 8e022877e9..47ac1a50b4 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -14,13 +14,6 @@ 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 8b4830223e..0986820f52 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -14,13 +14,6 @@ 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 da51de9fd9..aa8916a3f1 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -14,13 +14,6 @@ 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 289b13e617..7093c3112f 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -14,13 +14,6 @@ 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 bc9c70957a..7976cf1777 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -14,13 +14,6 @@ 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 e888100644..5f21f5853f 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -14,13 +14,6 @@ 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 ddf67b05cf..faa2be9d24 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -14,11 +14,6 @@ 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 880de1ea4f..633761f322 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -14,13 +14,6 @@ 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 dd5cd1cb44..58d31e6349 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -14,13 +14,6 @@ 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 1c237b3189..c0aaad11b2 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -14,11 +14,6 @@ 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 fc6d536c49..1977c6cda7 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -14,11 +14,6 @@ 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 e359263f83..e0a92bbcd7 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -14,11 +14,6 @@ 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 7ae06838a2..99f29fd56a 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -14,11 +14,6 @@ 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 1d8e798f9e..1b1ae15028 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -14,13 +14,6 @@ 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 6c617f0172..9ced3f51a8 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -14,13 +14,6 @@ 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 489fbcf667..26ea30cb0a 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -14,13 +14,6 @@ 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 c90d028463..65ff2f3863 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings.txt @@ -14,13 +14,6 @@ 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 a07a2984f8..20e4ac2898 100644 --- a/docs/command/atlas-federatedAuthentication.txt +++ b/docs/command/atlas-federatedAuthentication.txt @@ -14,13 +14,6 @@ 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 623e7478e9..4ff69b54d8 100644 --- a/docs/command/atlas-integrations-create-DATADOG.txt +++ b/docs/command/atlas-integrations-create-DATADOG.txt @@ -14,11 +14,6 @@ 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 6a510190df..f379cf6c82 100644 --- a/docs/command/atlas-integrations-create-OPS_GENIE.txt +++ b/docs/command/atlas-integrations-create-OPS_GENIE.txt @@ -14,11 +14,6 @@ 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 2cefcd5628..4772a69a43 100644 --- a/docs/command/atlas-integrations-create-PAGER_DUTY.txt +++ b/docs/command/atlas-integrations-create-PAGER_DUTY.txt @@ -14,11 +14,6 @@ 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 e626922f97..8c7bf304a2 100644 --- a/docs/command/atlas-integrations-create-VICTOR_OPS.txt +++ b/docs/command/atlas-integrations-create-VICTOR_OPS.txt @@ -14,11 +14,6 @@ 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 9abb2a4304..32dccd71c0 100644 --- a/docs/command/atlas-integrations-create-WEBHOOK.txt +++ b/docs/command/atlas-integrations-create-WEBHOOK.txt @@ -14,11 +14,6 @@ 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 5daecc739c..85048bcdb1 100644 --- a/docs/command/atlas-integrations-create.txt +++ b/docs/command/atlas-integrations-create.txt @@ -14,13 +14,6 @@ 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 c81f01844e..63239e640e 100644 --- a/docs/command/atlas-integrations-delete.txt +++ b/docs/command/atlas-integrations-delete.txt @@ -14,11 +14,6 @@ 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 9236f280c9..8d00468824 100644 --- a/docs/command/atlas-integrations-describe.txt +++ b/docs/command/atlas-integrations-describe.txt @@ -14,11 +14,6 @@ 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 879563f7af..46aefedf60 100644 --- a/docs/command/atlas-integrations-list.txt +++ b/docs/command/atlas-integrations-list.txt @@ -14,11 +14,6 @@ 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 92ca1d1af9..5324838902 100644 --- a/docs/command/atlas-integrations.txt +++ b/docs/command/atlas-integrations.txt @@ -14,13 +14,6 @@ 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 9f410ab0cc..dbdd664ecd 100644 --- a/docs/command/atlas-liveMigrations-create.txt +++ b/docs/command/atlas-liveMigrations-create.txt @@ -14,11 +14,6 @@ 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 2876298183..b52d4f9ee8 100644 --- a/docs/command/atlas-liveMigrations-cutover.txt +++ b/docs/command/atlas-liveMigrations-cutover.txt @@ -14,11 +14,6 @@ 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 fc5c697263..2798a01192 100644 --- a/docs/command/atlas-liveMigrations-describe.txt +++ b/docs/command/atlas-liveMigrations-describe.txt @@ -14,13 +14,6 @@ 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 dfdfb601a2..e736135d52 100644 --- a/docs/command/atlas-liveMigrations-link-create.txt +++ b/docs/command/atlas-liveMigrations-link-create.txt @@ -14,11 +14,6 @@ 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 e50a4af096..5b4573824a 100644 --- a/docs/command/atlas-liveMigrations-link-delete.txt +++ b/docs/command/atlas-liveMigrations-link-delete.txt @@ -14,13 +14,6 @@ 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 04ae43d877..7d81d1f085 100644 --- a/docs/command/atlas-liveMigrations-link.txt +++ b/docs/command/atlas-liveMigrations-link.txt @@ -14,13 +14,6 @@ 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 a427a5309a..f47530b581 100644 --- a/docs/command/atlas-liveMigrations-validation-create.txt +++ b/docs/command/atlas-liveMigrations-validation-create.txt @@ -14,11 +14,6 @@ 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 ab5baf9594..85cf8225b7 100644 --- a/docs/command/atlas-liveMigrations-validation-describe.txt +++ b/docs/command/atlas-liveMigrations-validation-describe.txt @@ -14,13 +14,6 @@ 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 da2ef7d201..e0e174761c 100644 --- a/docs/command/atlas-liveMigrations-validation.txt +++ b/docs/command/atlas-liveMigrations-validation.txt @@ -14,13 +14,6 @@ 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 90effdf80a..015e14547d 100644 --- a/docs/command/atlas-liveMigrations.txt +++ b/docs/command/atlas-liveMigrations.txt @@ -14,13 +14,6 @@ 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 30e7b5c91d..576714f0de 100644 --- a/docs/command/atlas-logs-download.txt +++ b/docs/command/atlas-logs-download.txt @@ -14,11 +14,6 @@ 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 ca910c3c48..36035a512e 100644 --- a/docs/command/atlas-logs.txt +++ b/docs/command/atlas-logs.txt @@ -14,13 +14,6 @@ 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 d268de7152..300aafbd30 100644 --- a/docs/command/atlas-maintenanceWindows-clear.txt +++ b/docs/command/atlas-maintenanceWindows-clear.txt @@ -14,11 +14,6 @@ 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 142f73f6ca..f586ce1e7e 100644 --- a/docs/command/atlas-maintenanceWindows-defer.txt +++ b/docs/command/atlas-maintenanceWindows-defer.txt @@ -14,11 +14,6 @@ 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 7ab67f4ab9..2401651d5e 100644 --- a/docs/command/atlas-maintenanceWindows-describe.txt +++ b/docs/command/atlas-maintenanceWindows-describe.txt @@ -14,11 +14,6 @@ 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 afe0e2be08..affa97dd2f 100644 --- a/docs/command/atlas-maintenanceWindows-update.txt +++ b/docs/command/atlas-maintenanceWindows-update.txt @@ -14,11 +14,6 @@ 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 d873ba6ecd..fa4ee9c2d8 100644 --- a/docs/command/atlas-maintenanceWindows.txt +++ b/docs/command/atlas-maintenanceWindows.txt @@ -14,13 +14,6 @@ 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 6d9ca9e037..74def3d321 100644 --- a/docs/command/atlas-metrics-databases-describe.txt +++ b/docs/command/atlas-metrics-databases-describe.txt @@ -14,11 +14,6 @@ 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 1be0cf3730..b3cc899445 100644 --- a/docs/command/atlas-metrics-databases-list.txt +++ b/docs/command/atlas-metrics-databases-list.txt @@ -14,11 +14,6 @@ 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 83f8f80bf4..2db0e1a894 100644 --- a/docs/command/atlas-metrics-databases.txt +++ b/docs/command/atlas-metrics-databases.txt @@ -14,13 +14,6 @@ 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 2948833c71..3e20344122 100644 --- a/docs/command/atlas-metrics-disks-describe.txt +++ b/docs/command/atlas-metrics-disks-describe.txt @@ -14,11 +14,6 @@ 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 86436a8b14..d541f41a04 100644 --- a/docs/command/atlas-metrics-disks-list.txt +++ b/docs/command/atlas-metrics-disks-list.txt @@ -14,11 +14,6 @@ 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 2c0651ea72..42bd8f2120 100644 --- a/docs/command/atlas-metrics-disks.txt +++ b/docs/command/atlas-metrics-disks.txt @@ -14,13 +14,6 @@ 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 6852b579cf..9ee270bb13 100644 --- a/docs/command/atlas-metrics-processes.txt +++ b/docs/command/atlas-metrics-processes.txt @@ -14,11 +14,6 @@ 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 dad08d1cd5..a1c5aadc66 100644 --- a/docs/command/atlas-metrics.txt +++ b/docs/command/atlas-metrics.txt @@ -14,13 +14,6 @@ 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 0eff902b03..689524ce53 100644 --- a/docs/command/atlas-networking-containers-delete.txt +++ b/docs/command/atlas-networking-containers-delete.txt @@ -14,11 +14,6 @@ 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 26ea59bb09..a8750b67d6 100644 --- a/docs/command/atlas-networking-containers-list.txt +++ b/docs/command/atlas-networking-containers-list.txt @@ -14,11 +14,6 @@ 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 de3d5bd384..6756369132 100644 --- a/docs/command/atlas-networking-containers.txt +++ b/docs/command/atlas-networking-containers.txt @@ -14,13 +14,6 @@ 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 9190d9e722..111a3de4cc 100644 --- a/docs/command/atlas-networking-peering-create-aws.txt +++ b/docs/command/atlas-networking-peering-create-aws.txt @@ -14,11 +14,6 @@ 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 6376ab7a2b..714d7b51a0 100644 --- a/docs/command/atlas-networking-peering-create-azure.txt +++ b/docs/command/atlas-networking-peering-create-azure.txt @@ -14,11 +14,6 @@ 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 e8428e69db..6110e4fcd2 100644 --- a/docs/command/atlas-networking-peering-create-gcp.txt +++ b/docs/command/atlas-networking-peering-create-gcp.txt @@ -14,11 +14,6 @@ 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 95c2a81eee..fbe947b7b4 100644 --- a/docs/command/atlas-networking-peering-create.txt +++ b/docs/command/atlas-networking-peering-create.txt @@ -14,13 +14,6 @@ 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 44a6c65e4f..ec44e2d033 100644 --- a/docs/command/atlas-networking-peering-delete.txt +++ b/docs/command/atlas-networking-peering-delete.txt @@ -14,11 +14,6 @@ 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 97fa456c28..e47c6e0848 100644 --- a/docs/command/atlas-networking-peering-list.txt +++ b/docs/command/atlas-networking-peering-list.txt @@ -14,11 +14,6 @@ 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 25b55ff492..7c8e3ec7af 100644 --- a/docs/command/atlas-networking-peering-watch.txt +++ b/docs/command/atlas-networking-peering-watch.txt @@ -14,11 +14,6 @@ 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 687e0a1cf5..fdeb3a8f5f 100644 --- a/docs/command/atlas-networking-peering.txt +++ b/docs/command/atlas-networking-peering.txt @@ -14,13 +14,6 @@ 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 6ee3e6788c..e98acb29b2 100644 --- a/docs/command/atlas-networking.txt +++ b/docs/command/atlas-networking.txt @@ -14,13 +14,6 @@ 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 a039b3524c..7ba279eced 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -14,11 +14,6 @@ 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 5a81d55149..76735790d6 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -14,11 +14,6 @@ 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 d255724bb9..b18ee729a7 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -14,11 +14,6 @@ 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 e7d543fdf9..93b1ff2009 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists.txt @@ -14,13 +14,6 @@ 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 64dd3d4fc8..b8893d9633 100644 --- a/docs/command/atlas-organizations-apiKeys-assign.txt +++ b/docs/command/atlas-organizations-apiKeys-assign.txt @@ -14,11 +14,6 @@ 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 b135cce186..4b8dbbf508 100644 --- a/docs/command/atlas-organizations-apiKeys-create.txt +++ b/docs/command/atlas-organizations-apiKeys-create.txt @@ -14,11 +14,6 @@ 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 f3595e7fb2..37edd780fe 100644 --- a/docs/command/atlas-organizations-apiKeys-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-delete.txt @@ -14,11 +14,6 @@ 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 ab7980d2ee..19b24d2cd3 100644 --- a/docs/command/atlas-organizations-apiKeys-describe.txt +++ b/docs/command/atlas-organizations-apiKeys-describe.txt @@ -14,11 +14,6 @@ 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 e812666638..5c6d5e5410 100644 --- a/docs/command/atlas-organizations-apiKeys-list.txt +++ b/docs/command/atlas-organizations-apiKeys-list.txt @@ -14,11 +14,6 @@ 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 be40b45439..d4af319a1e 100644 --- a/docs/command/atlas-organizations-apiKeys.txt +++ b/docs/command/atlas-organizations-apiKeys.txt @@ -14,13 +14,6 @@ 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 61091c0c2b..0631708209 100644 --- a/docs/command/atlas-organizations-create.txt +++ b/docs/command/atlas-organizations-create.txt @@ -14,11 +14,6 @@ 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 3fe1adae7a..1f6a6afc13 100644 --- a/docs/command/atlas-organizations-delete.txt +++ b/docs/command/atlas-organizations-delete.txt @@ -14,11 +14,6 @@ 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 722ee41300..52b0e108ea 100644 --- a/docs/command/atlas-organizations-describe.txt +++ b/docs/command/atlas-organizations-describe.txt @@ -14,11 +14,6 @@ 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 934847c776..ebd795ec8b 100644 --- a/docs/command/atlas-organizations-invitations-delete.txt +++ b/docs/command/atlas-organizations-invitations-delete.txt @@ -14,11 +14,6 @@ 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 f261f57b55..c842a75fb8 100644 --- a/docs/command/atlas-organizations-invitations-describe.txt +++ b/docs/command/atlas-organizations-invitations-describe.txt @@ -14,11 +14,6 @@ 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 34a17c3d61..d62a0a92f9 100644 --- a/docs/command/atlas-organizations-invitations-invite.txt +++ b/docs/command/atlas-organizations-invitations-invite.txt @@ -14,11 +14,6 @@ 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 4f48a09255..074015dd98 100644 --- a/docs/command/atlas-organizations-invitations-list.txt +++ b/docs/command/atlas-organizations-invitations-list.txt @@ -14,11 +14,6 @@ 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 74e04f0250..446dcf4ff0 100644 --- a/docs/command/atlas-organizations-invitations-update.txt +++ b/docs/command/atlas-organizations-invitations-update.txt @@ -14,11 +14,6 @@ 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 c0e1dfe05a..0135c98693 100644 --- a/docs/command/atlas-organizations-invitations.txt +++ b/docs/command/atlas-organizations-invitations.txt @@ -14,11 +14,6 @@ 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 76f481fe96..5248147670 100644 --- a/docs/command/atlas-organizations-list.txt +++ b/docs/command/atlas-organizations-list.txt @@ -14,11 +14,6 @@ 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 2cc14d066f..94299faa64 100644 --- a/docs/command/atlas-organizations-users-list.txt +++ b/docs/command/atlas-organizations-users-list.txt @@ -14,11 +14,6 @@ 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 e0319afe16..928a8825e1 100644 --- a/docs/command/atlas-organizations-users.txt +++ b/docs/command/atlas-organizations-users.txt @@ -14,13 +14,6 @@ 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 b6c694c2fb..fa2ee1e599 100644 --- a/docs/command/atlas-organizations.txt +++ b/docs/command/atlas-organizations.txt @@ -14,11 +14,6 @@ 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 ec9bb3ac8e..19b5659d0d 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces-list.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces-list.txt @@ -14,11 +14,6 @@ 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 34190e7c8d..e05970fbc6 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces.txt @@ -14,13 +14,6 @@ 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 92f48a8714..09b64bb4cf 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -14,11 +14,6 @@ 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 5b7d9adf3d..c47613c480 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -14,11 +14,6 @@ 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 dfb91ea603..a5ad1e3e3e 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -14,13 +14,6 @@ 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 a8bd30ec0d..52ad8c405e 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -14,11 +14,6 @@ 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 ba09f494d5..55a1fb2c0d 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -14,13 +14,6 @@ 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 e022efb786..bcf0b527fd 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -14,11 +14,6 @@ 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 76a3635b45..b765cf2ebd 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -14,13 +14,6 @@ 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 7549addd09..4428b2f1ea 100644 --- a/docs/command/atlas-performanceAdvisor.txt +++ b/docs/command/atlas-performanceAdvisor.txt @@ -14,13 +14,6 @@ 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 42a69804e0..c53cddaabe 100644 --- a/docs/command/atlas-plugin-install.txt +++ b/docs/command/atlas-plugin-install.txt @@ -14,11 +14,6 @@ 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 15389bf918..eced103a63 100644 --- a/docs/command/atlas-plugin-list.txt +++ b/docs/command/atlas-plugin-list.txt @@ -14,13 +14,6 @@ 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 4bd502c1fc..6117d6b567 100644 --- a/docs/command/atlas-plugin-uninstall.txt +++ b/docs/command/atlas-plugin-uninstall.txt @@ -14,11 +14,6 @@ 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 a8f55f7343..5f70c3da01 100644 --- a/docs/command/atlas-plugin-update.txt +++ b/docs/command/atlas-plugin-update.txt @@ -14,11 +14,6 @@ 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 cde9a89012..c3c489f453 100644 --- a/docs/command/atlas-plugin.txt +++ b/docs/command/atlas-plugin.txt @@ -14,13 +14,6 @@ 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 dc8508e098..3dc0a82304 100644 --- a/docs/command/atlas-privateEndpoints-aws-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-create.txt @@ -14,11 +14,6 @@ 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 eb5e8b8224..99afb3ecc3 100644 --- a/docs/command/atlas-privateEndpoints-aws-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-delete.txt @@ -14,11 +14,6 @@ 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 9817400dcd..73d6bc46c0 100644 --- a/docs/command/atlas-privateEndpoints-aws-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-describe.txt @@ -14,11 +14,6 @@ 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 02ca7211fb..fcaeafe85a 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -14,11 +14,6 @@ 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 c68c1aa2a4..11f4b27f9e 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -14,11 +14,6 @@ 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 48c3251044..4c42cf4c27 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -14,11 +14,6 @@ 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 8f34b38118..eefb55825a 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces.txt @@ -14,13 +14,6 @@ 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 bb582ae1bb..d73ffa7d70 100644 --- a/docs/command/atlas-privateEndpoints-aws-list.txt +++ b/docs/command/atlas-privateEndpoints-aws-list.txt @@ -14,11 +14,6 @@ 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 c033fc5d11..2882272d4d 100644 --- a/docs/command/atlas-privateEndpoints-aws-watch.txt +++ b/docs/command/atlas-privateEndpoints-aws-watch.txt @@ -14,11 +14,6 @@ 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 9660c5efee..d761c7a4ed 100644 --- a/docs/command/atlas-privateEndpoints-aws.txt +++ b/docs/command/atlas-privateEndpoints-aws.txt @@ -14,13 +14,6 @@ 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 2e6073982e..70c1bb7a91 100644 --- a/docs/command/atlas-privateEndpoints-azure-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-create.txt @@ -14,11 +14,6 @@ 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 868f482387..d450ade535 100644 --- a/docs/command/atlas-privateEndpoints-azure-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-delete.txt @@ -14,11 +14,6 @@ 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 2c0d1076fa..08ea40362d 100644 --- a/docs/command/atlas-privateEndpoints-azure-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-describe.txt @@ -14,11 +14,6 @@ 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 c497a4163a..78aaaa4164 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -14,11 +14,6 @@ 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 151746a489..f09ff091c7 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -14,11 +14,6 @@ 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 ff5cfdfb77..bd17506aa5 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -14,11 +14,6 @@ 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 952c255d3a..937d2aacae 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces.txt @@ -14,13 +14,6 @@ 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 096d98ab5d..3564976b5a 100644 --- a/docs/command/atlas-privateEndpoints-azure-list.txt +++ b/docs/command/atlas-privateEndpoints-azure-list.txt @@ -14,11 +14,6 @@ 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 e0005181fe..fa8ad3dec8 100644 --- a/docs/command/atlas-privateEndpoints-azure-watch.txt +++ b/docs/command/atlas-privateEndpoints-azure-watch.txt @@ -14,11 +14,6 @@ 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 e73eb1180f..23b7368dd2 100644 --- a/docs/command/atlas-privateEndpoints-azure.txt +++ b/docs/command/atlas-privateEndpoints-azure.txt @@ -14,13 +14,6 @@ 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 5aa8f02709..9da00080e5 100644 --- a/docs/command/atlas-privateEndpoints-gcp-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-create.txt @@ -14,11 +14,6 @@ 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 6500572f82..a9f0a42728 100644 --- a/docs/command/atlas-privateEndpoints-gcp-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-delete.txt @@ -14,11 +14,6 @@ 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 a699afa0b0..aa00926e04 100644 --- a/docs/command/atlas-privateEndpoints-gcp-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-describe.txt @@ -14,11 +14,6 @@ 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 9d2f76941d..c88a72796d 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -14,11 +14,6 @@ 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 a91ae03d8d..f9513ead7f 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -14,11 +14,6 @@ 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 a938051cb9..db04731d9a 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -14,11 +14,6 @@ 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 828182a74b..ec3ec345fc 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -14,13 +14,6 @@ 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 bb887d3c57..26f48fd754 100644 --- a/docs/command/atlas-privateEndpoints-gcp-list.txt +++ b/docs/command/atlas-privateEndpoints-gcp-list.txt @@ -14,11 +14,6 @@ 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 1fbb0b800a..5741d695f6 100644 --- a/docs/command/atlas-privateEndpoints-gcp-watch.txt +++ b/docs/command/atlas-privateEndpoints-gcp-watch.txt @@ -14,11 +14,6 @@ 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 5f4d56f2eb..29405adf0f 100644 --- a/docs/command/atlas-privateEndpoints-gcp.txt +++ b/docs/command/atlas-privateEndpoints-gcp.txt @@ -14,13 +14,6 @@ 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 be827fafd9..f378aad693 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -14,11 +14,6 @@ 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 0b0f0f65ef..22b38a3e8b 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -14,11 +14,6 @@ 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 667c08260c..e7caddbbe0 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -14,11 +14,6 @@ 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 1314cd50c3..87c8064d9b 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes.txt @@ -14,13 +14,6 @@ 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 86ac946ac6..8a05ab2145 100644 --- a/docs/command/atlas-privateEndpoints.txt +++ b/docs/command/atlas-privateEndpoints.txt @@ -14,13 +14,6 @@ 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 064264d664..d96733b374 100644 --- a/docs/command/atlas-processes-describe.txt +++ b/docs/command/atlas-processes-describe.txt @@ -14,13 +14,6 @@ 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 c488e2fcd6..6f575dfbeb 100644 --- a/docs/command/atlas-processes-list.txt +++ b/docs/command/atlas-processes-list.txt @@ -14,11 +14,6 @@ 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 866cb046f2..5fd7e81a35 100644 --- a/docs/command/atlas-processes.txt +++ b/docs/command/atlas-processes.txt @@ -14,13 +14,6 @@ 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 ac6bcc9818..d9e0d36391 100644 --- a/docs/command/atlas-projects-apiKeys-assign.txt +++ b/docs/command/atlas-projects-apiKeys-assign.txt @@ -14,11 +14,6 @@ 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 2a1708e48d..b464fb2222 100644 --- a/docs/command/atlas-projects-apiKeys-create.txt +++ b/docs/command/atlas-projects-apiKeys-create.txt @@ -14,11 +14,6 @@ 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 7501f8b555..c2b2fbc72c 100644 --- a/docs/command/atlas-projects-apiKeys-delete.txt +++ b/docs/command/atlas-projects-apiKeys-delete.txt @@ -14,11 +14,6 @@ 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 41e8846d06..4f26094679 100644 --- a/docs/command/atlas-projects-apiKeys-list.txt +++ b/docs/command/atlas-projects-apiKeys-list.txt @@ -14,11 +14,6 @@ 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 ba84de54e3..aa4c4c61da 100644 --- a/docs/command/atlas-projects-apiKeys.txt +++ b/docs/command/atlas-projects-apiKeys.txt @@ -14,13 +14,6 @@ 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 f7dffbe5aa..2fa91868b6 100644 --- a/docs/command/atlas-projects-create.txt +++ b/docs/command/atlas-projects-create.txt @@ -14,11 +14,6 @@ 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 1d2aaad0e1..840a40a2fa 100644 --- a/docs/command/atlas-projects-delete.txt +++ b/docs/command/atlas-projects-delete.txt @@ -14,11 +14,6 @@ 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 02dbf663d3..2d32ee6d1b 100644 --- a/docs/command/atlas-projects-describe.txt +++ b/docs/command/atlas-projects-describe.txt @@ -14,11 +14,6 @@ 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 1993d5de06..d34deeb096 100644 --- a/docs/command/atlas-projects-list.txt +++ b/docs/command/atlas-projects-list.txt @@ -14,11 +14,6 @@ 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 01b89daaec..a69830c3d1 100644 --- a/docs/command/atlas-projects-settings-describe.txt +++ b/docs/command/atlas-projects-settings-describe.txt @@ -14,13 +14,6 @@ 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 b2351b4304..3a8fe62e87 100644 --- a/docs/command/atlas-projects-settings-update.txt +++ b/docs/command/atlas-projects-settings-update.txt @@ -14,13 +14,6 @@ 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 6ba1110600..8671663757 100644 --- a/docs/command/atlas-projects-settings.txt +++ b/docs/command/atlas-projects-settings.txt @@ -14,11 +14,6 @@ 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 7194a8c4e8..f8670378f0 100644 --- a/docs/command/atlas-projects-teams-add.txt +++ b/docs/command/atlas-projects-teams-add.txt @@ -14,11 +14,6 @@ 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 1f10432b61..1f5819a10d 100644 --- a/docs/command/atlas-projects-teams-delete.txt +++ b/docs/command/atlas-projects-teams-delete.txt @@ -14,11 +14,6 @@ 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 8bd4385f22..12e530a794 100644 --- a/docs/command/atlas-projects-teams-list.txt +++ b/docs/command/atlas-projects-teams-list.txt @@ -14,11 +14,6 @@ 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 5090822fbc..02527e0e2e 100644 --- a/docs/command/atlas-projects-teams-update.txt +++ b/docs/command/atlas-projects-teams-update.txt @@ -14,11 +14,6 @@ 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 7b11e7f1c9..b215be2184 100644 --- a/docs/command/atlas-projects-teams.txt +++ b/docs/command/atlas-projects-teams.txt @@ -14,13 +14,6 @@ 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 8c2d7cc102..3c037c1528 100644 --- a/docs/command/atlas-projects-update.txt +++ b/docs/command/atlas-projects-update.txt @@ -14,11 +14,6 @@ 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 873b0416eb..870543b4f6 100644 --- a/docs/command/atlas-projects-users-delete.txt +++ b/docs/command/atlas-projects-users-delete.txt @@ -14,11 +14,6 @@ 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 fadf573f78..fda0542dcb 100644 --- a/docs/command/atlas-projects-users-list.txt +++ b/docs/command/atlas-projects-users-list.txt @@ -14,11 +14,6 @@ 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 072ab816c9..0292d11497 100644 --- a/docs/command/atlas-projects-users.txt +++ b/docs/command/atlas-projects-users.txt @@ -14,13 +14,6 @@ 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 c7ea4e8304..b7e5825090 100644 --- a/docs/command/atlas-projects.txt +++ b/docs/command/atlas-projects.txt @@ -14,11 +14,6 @@ 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 5d573b29f4..f22030f134 100644 --- a/docs/command/atlas-security-customerCerts-create.txt +++ b/docs/command/atlas-security-customerCerts-create.txt @@ -14,11 +14,6 @@ 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 73c488a5a0..c94b4cad31 100644 --- a/docs/command/atlas-security-customerCerts-describe.txt +++ b/docs/command/atlas-security-customerCerts-describe.txt @@ -14,11 +14,6 @@ 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 53f2727ac5..c45f4712e1 100644 --- a/docs/command/atlas-security-customerCerts-disable.txt +++ b/docs/command/atlas-security-customerCerts-disable.txt @@ -14,11 +14,6 @@ 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 f99bba7e9c..9b8a81fb98 100644 --- a/docs/command/atlas-security-customerCerts.txt +++ b/docs/command/atlas-security-customerCerts.txt @@ -14,13 +14,6 @@ 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 4fb081bec3..1a26083803 100644 --- a/docs/command/atlas-security-ldap-delete.txt +++ b/docs/command/atlas-security-ldap-delete.txt @@ -14,11 +14,6 @@ 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 faef6899dd..359a0931fc 100644 --- a/docs/command/atlas-security-ldap-get.txt +++ b/docs/command/atlas-security-ldap-get.txt @@ -14,11 +14,6 @@ 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 ebc5e6ac4e..8bae744bc4 100644 --- a/docs/command/atlas-security-ldap-save.txt +++ b/docs/command/atlas-security-ldap-save.txt @@ -14,11 +14,6 @@ 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 3e5781742c..8a13c69d21 100644 --- a/docs/command/atlas-security-ldap-verify-status-watch.txt +++ b/docs/command/atlas-security-ldap-verify-status-watch.txt @@ -14,11 +14,6 @@ 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 b419753a15..3458531de3 100644 --- a/docs/command/atlas-security-ldap-verify-status.txt +++ b/docs/command/atlas-security-ldap-verify-status.txt @@ -14,11 +14,6 @@ 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 2ec1b45b5c..1a76e01654 100644 --- a/docs/command/atlas-security-ldap-verify.txt +++ b/docs/command/atlas-security-ldap-verify.txt @@ -14,11 +14,6 @@ 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 ff9c4b1cce..20627d1405 100644 --- a/docs/command/atlas-security-ldap.txt +++ b/docs/command/atlas-security-ldap.txt @@ -14,13 +14,6 @@ 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 da1144d779..3457b5871d 100644 --- a/docs/command/atlas-security.txt +++ b/docs/command/atlas-security.txt @@ -14,13 +14,6 @@ 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 01a4eed2d1..a42ff8a759 100644 --- a/docs/command/atlas-setup.txt +++ b/docs/command/atlas-setup.txt @@ -14,11 +14,6 @@ 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 853805c5be..41218f319d 100644 --- a/docs/command/atlas-streams-connections-create.txt +++ b/docs/command/atlas-streams-connections-create.txt @@ -14,11 +14,6 @@ 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 7ad329f386..28a82a8881 100644 --- a/docs/command/atlas-streams-connections-delete.txt +++ b/docs/command/atlas-streams-connections-delete.txt @@ -14,11 +14,6 @@ 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 3aa0a5b750..9c0081ac67 100644 --- a/docs/command/atlas-streams-connections-describe.txt +++ b/docs/command/atlas-streams-connections-describe.txt @@ -14,11 +14,6 @@ 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 41ee6fc3ae..3acd0d2a5d 100644 --- a/docs/command/atlas-streams-connections-list.txt +++ b/docs/command/atlas-streams-connections-list.txt @@ -14,11 +14,6 @@ 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 ecd625b87c..12c4c249b7 100644 --- a/docs/command/atlas-streams-connections-update.txt +++ b/docs/command/atlas-streams-connections-update.txt @@ -14,11 +14,6 @@ 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 cd3cafa2c5..2c40745051 100644 --- a/docs/command/atlas-streams-connections.txt +++ b/docs/command/atlas-streams-connections.txt @@ -14,11 +14,6 @@ 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 e1f3b620fb..7b3f705da8 100644 --- a/docs/command/atlas-streams-instances-create.txt +++ b/docs/command/atlas-streams-instances-create.txt @@ -14,11 +14,6 @@ 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 940cf5bbfb..f7e1a66ae8 100644 --- a/docs/command/atlas-streams-instances-delete.txt +++ b/docs/command/atlas-streams-instances-delete.txt @@ -14,11 +14,6 @@ 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 1f4c29d4ad..e701019c47 100644 --- a/docs/command/atlas-streams-instances-describe.txt +++ b/docs/command/atlas-streams-instances-describe.txt @@ -14,11 +14,6 @@ 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 9407e81fcf..8cee843c81 100644 --- a/docs/command/atlas-streams-instances-download.txt +++ b/docs/command/atlas-streams-instances-download.txt @@ -14,11 +14,6 @@ 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 164d1dc330..43620f92c8 100644 --- a/docs/command/atlas-streams-instances-list.txt +++ b/docs/command/atlas-streams-instances-list.txt @@ -14,11 +14,6 @@ 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 edbbd29a28..fb6875d5fa 100644 --- a/docs/command/atlas-streams-instances-update.txt +++ b/docs/command/atlas-streams-instances-update.txt @@ -14,11 +14,6 @@ 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 1d6cd3a275..88cb43a8a5 100644 --- a/docs/command/atlas-streams-instances.txt +++ b/docs/command/atlas-streams-instances.txt @@ -14,11 +14,6 @@ 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 24fbd53efc..ff0d3d6fe9 100644 --- a/docs/command/atlas-streams-privateLinks-create.txt +++ b/docs/command/atlas-streams-privateLinks-create.txt @@ -14,11 +14,6 @@ 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 cec3782bf0..9d7ca42f84 100644 --- a/docs/command/atlas-streams-privateLinks-delete.txt +++ b/docs/command/atlas-streams-privateLinks-delete.txt @@ -14,11 +14,6 @@ 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 aa3027e9ad..202502f7ec 100644 --- a/docs/command/atlas-streams-privateLinks-describe.txt +++ b/docs/command/atlas-streams-privateLinks-describe.txt @@ -14,11 +14,6 @@ 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 c3f132d634..064f1e9cf7 100644 --- a/docs/command/atlas-streams-privateLinks-list.txt +++ b/docs/command/atlas-streams-privateLinks-list.txt @@ -14,11 +14,6 @@ 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 1665d31265..47740b5d20 100644 --- a/docs/command/atlas-streams-privateLinks.txt +++ b/docs/command/atlas-streams-privateLinks.txt @@ -14,11 +14,6 @@ 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 5a458be2d6..d0a648bac8 100644 --- a/docs/command/atlas-streams.txt +++ b/docs/command/atlas-streams.txt @@ -14,11 +14,6 @@ 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 83bfc9fccf..9bb807539e 100644 --- a/docs/command/atlas-teams-create.txt +++ b/docs/command/atlas-teams-create.txt @@ -14,11 +14,6 @@ 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 d75e4b6c4b..3be0a283e1 100644 --- a/docs/command/atlas-teams-delete.txt +++ b/docs/command/atlas-teams-delete.txt @@ -14,11 +14,6 @@ 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 ca91b21dca..e13b21c7d0 100644 --- a/docs/command/atlas-teams-describe.txt +++ b/docs/command/atlas-teams-describe.txt @@ -14,11 +14,6 @@ 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 dd50da867d..f454ff6762 100644 --- a/docs/command/atlas-teams-list.txt +++ b/docs/command/atlas-teams-list.txt @@ -14,11 +14,6 @@ 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 4579c28dd5..867a75b2f8 100644 --- a/docs/command/atlas-teams-rename.txt +++ b/docs/command/atlas-teams-rename.txt @@ -14,11 +14,6 @@ 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 355c84ab3d..eeb6319874 100644 --- a/docs/command/atlas-teams-users-add.txt +++ b/docs/command/atlas-teams-users-add.txt @@ -14,11 +14,6 @@ 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 bd9495fb65..4cd64e07bd 100644 --- a/docs/command/atlas-teams-users-delete.txt +++ b/docs/command/atlas-teams-users-delete.txt @@ -14,11 +14,6 @@ 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 6c24a4fd05..ae494e0213 100644 --- a/docs/command/atlas-teams-users-list.txt +++ b/docs/command/atlas-teams-users-list.txt @@ -14,11 +14,6 @@ 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 1da6bd8d9b..d8724b0790 100644 --- a/docs/command/atlas-teams-users.txt +++ b/docs/command/atlas-teams-users.txt @@ -14,11 +14,6 @@ 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 fb5675a7f7..a32ada2f2b 100644 --- a/docs/command/atlas-teams.txt +++ b/docs/command/atlas-teams.txt @@ -14,11 +14,6 @@ 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 039d628e30..4ec47d18a5 100644 --- a/docs/command/atlas-users-describe.txt +++ b/docs/command/atlas-users-describe.txt @@ -14,11 +14,6 @@ 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 f2b351604c..7b5ebd3250 100644 --- a/docs/command/atlas-users-invite.txt +++ b/docs/command/atlas-users-invite.txt @@ -14,11 +14,6 @@ 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 08d0588408..7507d266ab 100644 --- a/docs/command/atlas-users.txt +++ b/docs/command/atlas-users.txt @@ -14,11 +14,6 @@ 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 a19aa90b59..86269996d6 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -14,11 +14,6 @@ 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. diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index b44501d8ab..775b45cfe1 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -21,12 +21,12 @@ const ( {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ExperimentalText = "Public Preview: The atlas api sub-command, " + + ExperimentalText = "The atlas api sub-command, " + "automatically generated from the MongoDB Atlas Admin API, offers 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 + ExperimentalHelpTemplate = "Public Preview: " + ExperimentalText + HelpTemplate ) diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index 3fcb767e17..a9aba25d31 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -43,7 +43,6 @@ 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 @@ -63,6 +62,7 @@ func markExperimentalToAPICommands(cmd *cobra.Command) { return // Skip the root command } cmd.Short = "`Public Preview: please provide feedback `_: " + cmd.Short + cmd.Long = cli.ExperimentalText + cmd.Long } func updateAPICommandDescription(cmd *cobra.Command) {