mongodb · apix-bot · Jul 15, 2025
@@ -17,7 +17,7 @@ atlas api organizations getOrganizationSettings
 The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
 Admin API capabilities have their own release lifecycle, which 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.
+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-getorganizationsettings.
 

@@ -0,0 +1,122 @@
+.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails:
+
+====================================================================
+atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails
+====================================================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the metadata and statistics summary for a given query shape hash.
+
+The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-getgroupclusterqueryshapeinsightdetails.
+
+For more information and examples, see the referenced API documentation linked above.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails [options]
+
+.. Code end marker, please don't delete this comment
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - --clusterName
+     - string
+     - true
+     - Human-readable label that identifies the cluster.
+   * - --envelope
+     - envelope
+     - false
+     - Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
+   * - --groupId
+     - string
+     - true
+     - Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
+
+       **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
+   * - -h, --help
+     - 
+     - false
+     - help for getGroupClusterQueryShapeInsightDetails
+   * - -o, --output
+     - string
+     - false
+     - preferred api format, can be ["json", go-template] This value defaults to "json".
+   * - --outputFile
+     - string
+     - false
+     - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
+   * - --pretty
+     - 
+     - false
+     - Flag that indicates whether the response body should be in the prettyprint format.
+   * - --processIds
+     - mongod
+     - false
+     - ProcessIds from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.
+   * - --queryShapeHash
+     - string
+     - true
+     - A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.
+   * - --since
+     - int
+     - false
+     - Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
+
+       - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.
+       - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
+   * - --until
+     - int
+     - false
+     - Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
+
+       - If you specify the **until** parameter, you must specify the **since** parameter.
+       - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
+   * - --version
+     - string
+     - false
+     - api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12".
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Examples
+--------
+
+.. literalinclude:: /includes/examples/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh
+   :language: shell
@@ -0,0 +1,140 @@
+.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries:
+
+======================================================================
+atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries
+======================================================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns a list of query shape statistics summaries for a given cluster.
+
+The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
+Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
+
+Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations.
+
+This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterqueryshapeinsightsummaries.
+
+For more information and examples, see the referenced API documentation linked above.
+
+Syntax
+------
+
+.. code-block::
+   :caption: Command Syntax
+
+   atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries [options]
+
+.. Code end marker, please don't delete this comment
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - --clusterName
+     - string
+     - true
+     - Human-readable label that identifies the cluster.
+   * - --commands
+     - &
+     - false
+     - Retrieve query shape statistics matching specified MongoDB commands. To include multiple commands, pass the parameter multiple times delimited with an ampersand (&) between each command. The currently supported parameters are find, distinct, and aggregate. Omit this parameter to return results for all supported commands.
+   * - --envelope
+     - envelope
+     - false
+     - Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
+   * - --groupId
+     - string
+     - true
+     - Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
+
+       **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
+   * - -h, --help
+     - 
+     - false
+     - help for getGroupClusterQueryShapeInsightSummaries
+   * - --nSummaries
+     - int
+     - false
+     - Maximum number of query statistic summaries to return.
+   * - --namespaces
+     - .
+     - false
+     - Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as .: ``<database>.<collection>``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.
+   * - -o, --output
+     - string
+     - false
+     - preferred api format, can be ["json", go-template] This value defaults to "json".
+   * - --outputFile
+     - string
+     - false
+     - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
+   * - --pretty
+     - 
+     - false
+     - Flag that indicates whether the response body should be in the prettyprint format.
+   * - --processIds
+     - mongod
+     - false
+     - ProcessIds from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.
+   * - --queryShapeHashes
+     - &
+     - false
+     - A list of SHA256 hashes of desired query shapes, output by MongoDB commands like $queryStats and $explain or slow query logs. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series.
+   * - --series
+     - &
+     - false
+     - Query shape statistics data series to retrieve. A series represents a specific metric about query execution. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series.
+   * - --since
+     - int
+     - false
+     - Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
+
+       - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.
+       - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
+   * - --until
+     - int
+     - false
+     - Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
+
+       - If you specify the **until** parameter, you must specify the **since** parameter.
+       - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
+   * - --version
+     - string
+     - false
+     - api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12".
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Examples
+--------
+
+.. literalinclude:: /includes/examples/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh
+   :language: shell
@@ -0,0 +1,66 @@
+.. _atlas-api-queryShapeInsights:
+
+============================
+atlas api queryShapeInsights
+============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 
+
+The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -h, --help
+     - 
+     - false
+     - help for queryShapeInsights
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
+
+Related Commands
+----------------
+
+* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the metadata and statistics summary for a given query shape hash.
+* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns a list of query shape statistics summaries for a given cluster.
+
+
+.. toctree::
+   :titlesonly:
+
+   getGroupClusterQueryShapeInsightDetails </command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails>
+   getGroupClusterQueryShapeInsightSummaries </command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries>
+
@@ -1,8 +1,8 @@
-.. _atlas-api-resourcePolicies-createAtlasResourcePolicy:
+.. _atlas-api-resourcePolicies-createOrgResourcePolicy:
 
-====================================================
-atlas api resourcePolicies createAtlasResourcePolicy
-====================================================
+==================================================
+atlas api resourcePolicies createOrgResourcePolicy
+==================================================
 
 .. default-domain:: mongodb
 
@@ -17,7 +17,7 @@ atlas api resourcePolicies createAtlasResourcePolicy
 The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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.
+This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgresourcepolicy.
 
 For more information and examples, see the referenced API documentation linked above.
 
@@ -27,7 +27,7 @@ Syntax
 .. code-block::
    :caption: Command Syntax
 
-   atlas api resourcePolicies createAtlasResourcePolicy [options]
+   atlas api resourcePolicies createOrgResourcePolicy [options]
 
 .. Code end marker, please don't delete this comment
 
@@ -53,7 +53,7 @@ Options
    * - -h, --help
      - 
      - false
-     - help for createAtlasResourcePolicy
+     - help for createOrgResourcePolicy
    * - --orgId
      - string
      - true