diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 56e2d06086..6323add4b5 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -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. diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt new file mode 100644 index 0000000000..795eade289 --- /dev/null +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt @@ -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 `_: 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 diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt new file mode 100644 index 0000000000..f61a0f7c3b --- /dev/null +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt @@ -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 `_: 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 .: ``.``. 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 diff --git a/docs/command/atlas-api-queryShapeInsights.txt b/docs/command/atlas-api-queryShapeInsights.txt new file mode 100644 index 0000000000..8aa62bb13b --- /dev/null +++ b/docs/command/atlas-api-queryShapeInsights.txt @@ -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 `_: + +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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 `_: Returns the metadata and statistics summary for a given query shape hash. +* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - `Public Preview: please provide feedback `_: Returns a list of query shape statistics summaries for a given cluster. + + +.. toctree:: + :titlesonly: + + getGroupClusterQueryShapeInsightDetails + getGroupClusterQueryShapeInsightSummaries + diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt similarity index 89% rename from docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt rename to docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt index d9c94ee48a..a1090619b6 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt @@ -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 diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt similarity index 88% rename from docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt rename to docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt index be36c1d8a9..5f45e328d6 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt @@ -1,8 +1,8 @@ -.. _atlas-api-resourcePolicies-deleteAtlasResourcePolicy: +.. _atlas-api-resourcePolicies-deleteOrgResourcePolicy: -==================================================== -atlas api resourcePolicies deleteAtlasResourcePolicy -==================================================== +================================================== +atlas api resourcePolicies deleteOrgResourcePolicy +================================================== .. default-domain:: mongodb @@ -17,7 +17,7 @@ atlas api resourcePolicies deleteAtlasResourcePolicy The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgresourcepolicy. 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 deleteAtlasResourcePolicy [options] + atlas api resourcePolicies deleteOrgResourcePolicy [options] .. Code end marker, please don't delete this comment @@ -49,7 +49,7 @@ Options * - -h, --help - - false - - help for deleteAtlasResourcePolicy + - help for deleteOrgResourcePolicy * - --orgId - string - true @@ -94,5 +94,5 @@ Inherited Options Examples -------- -.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh +.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-deleteOrgResourcePolicy-2024-08-05-default.sh :language: shell diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt similarity index 88% rename from docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt rename to docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt index 94d291b92e..6f9317dc16 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt @@ -1,8 +1,8 @@ -.. _atlas-api-resourcePolicies-getAtlasResourcePolicy: +.. _atlas-api-resourcePolicies-getOrgResourcePolicy: -================================================= -atlas api resourcePolicies getAtlasResourcePolicy -================================================= +=============================================== +atlas api resourcePolicies getOrgResourcePolicy +=============================================== .. default-domain:: mongodb @@ -17,7 +17,7 @@ atlas api resourcePolicies getAtlasResourcePolicy The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgresourcepolicy. 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 getAtlasResourcePolicy [options] + atlas api resourcePolicies getOrgResourcePolicy [options] .. Code end marker, please don't delete this comment @@ -49,7 +49,7 @@ Options * - -h, --help - - false - - help for getAtlasResourcePolicy + - help for getOrgResourcePolicy * - --orgId - string - true @@ -94,5 +94,5 @@ Inherited Options Examples -------- -.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getAtlasResourcePolicy-2024-08-05-default.sh +.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getOrgResourcePolicy-2024-08-05-default.sh :language: shell diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt similarity index 87% rename from docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt rename to docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt index 575ca702cd..c634310886 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt @@ -1,8 +1,8 @@ -.. _atlas-api-resourcePolicies-getAtlasResourcePolicies: +.. _atlas-api-resourcePolicies-listOrgResourcePolicies: -=================================================== -atlas api resourcePolicies getAtlasResourcePolicies -=================================================== +================================================== +atlas api resourcePolicies listOrgResourcePolicies +================================================== .. default-domain:: mongodb @@ -17,7 +17,7 @@ atlas api resourcePolicies getAtlasResourcePolicies The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgresourcepolicies. 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 getAtlasResourcePolicies [options] + atlas api resourcePolicies listOrgResourcePolicies [options] .. Code end marker, please don't delete this comment @@ -49,7 +49,7 @@ Options * - -h, --help - - false - - help for getAtlasResourcePolicies + - help for listOrgResourcePolicies * - --orgId - string - true @@ -90,5 +90,5 @@ Inherited Options Examples -------- -.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getAtlasResourcePolicies-2024-08-05-default.sh +.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-listOrgResourcePolicies-2024-08-05-default.sh :language: shell diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt similarity index 89% rename from docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt rename to docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt index 256e130627..758745f15a 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt @@ -1,8 +1,8 @@ -.. _atlas-api-resourcePolicies-updateAtlasResourcePolicy: +.. _atlas-api-resourcePolicies-updateOrgResourcePolicy: -==================================================== -atlas api resourcePolicies updateAtlasResourcePolicy -==================================================== +================================================== +atlas api resourcePolicies updateOrgResourcePolicy +================================================== .. default-domain:: mongodb @@ -17,7 +17,7 @@ atlas api resourcePolicies updateAtlasResourcePolicy The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgresourcepolicy. 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 updateAtlasResourcePolicy [options] + atlas api resourcePolicies updateOrgResourcePolicy [options] .. Code end marker, please don't delete this comment @@ -53,7 +53,7 @@ Options * - -h, --help - - false - - help for updateAtlasResourcePolicy + - help for updateOrgResourcePolicy * - --orgId - string - true diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 0b901cbd43..6d8d4e3537 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -54,23 +54,23 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createOrgResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteOrgResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getOrgResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. * :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback `_: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-listOrgResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-updateOrgResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. * :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. .. toctree:: :titlesonly: - createAtlasResourcePolicy - deleteAtlasResourcePolicy - getAtlasResourcePolicies - getAtlasResourcePolicy + createOrgResourcePolicy + deleteOrgResourcePolicy + getOrgResourcePolicy getResourcesNonCompliant - updateAtlasResourcePolicy + listOrgResourcePolicies + updateOrgResourcePolicy validateAtlasResourcePolicy diff --git a/docs/command/atlas-api-teams-getProjectTeam.txt b/docs/command/atlas-api-teams-getProjectTeam.txt new file mode 100644 index 0000000000..a7d0e952d6 --- /dev/null +++ b/docs/command/atlas-api-teams-getProjectTeam.txt @@ -0,0 +1,102 @@ +.. _atlas-api-teams-getProjectTeam: + +============================== +atlas api teams getProjectTeam +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +`Public Preview: please provide feedback `_: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. + +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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-getprojectteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams getProjectTeam [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 + * - --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 getProjectTeam + * - -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. + * - --teamId + - string + - true + - Unique 24-hexadecimal digit string that identifies the team for which you want to get. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". + +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-teams-getProjectTeam-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 551d4f1392..fda64ae254 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -58,6 +58,7 @@ Related Commands * :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. * :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback `_: Creates one team in the specified organization. * :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-getProjectTeam` - `Public Preview: please provide feedback `_: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. * :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. * :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. * :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. @@ -75,6 +76,7 @@ Related Commands addTeamUser createTeam deleteTeam + getProjectTeam getTeamById getTeamByName listOrganizationTeams diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 441d32e516..10c12208e5 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -212,6 +212,7 @@ Related Commands * :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. * :ref:`atlas-api-projects` - `Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. * :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-queryShapeInsights` - `Public Preview: please provide feedback `_: * :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. * :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. * :ref:`atlas-api-root` - `Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. @@ -267,6 +268,7 @@ Related Commands projectIpAccessList projects pushBasedLogExport + queryShapeInsights resourcePolicies rollingIndex root diff --git a/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh b/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh new file mode 100644 index 0000000000..fa13997732 --- /dev/null +++ b/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh @@ -0,0 +1 @@ +atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --queryShapeHash [queryShapeHash] diff --git a/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh b/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh new file mode 100644 index 0000000000..536a568a9e --- /dev/null +++ b/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh @@ -0,0 +1 @@ +atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh deleted file mode 100644 index d18361ad61..0000000000 --- a/docs/command/includes/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-deleteOrgResourcePolicy-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-deleteOrgResourcePolicy-2024-08-05-default.sh new file mode 100644 index 0000000000..6a43855b08 --- /dev/null +++ b/docs/command/includes/atlas-api-resourcePolicies-deleteOrgResourcePolicy-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api resourcePolicies deleteOrgResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicies-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicies-2024-08-05-default.sh deleted file mode 100644 index 0c325c0e21..0000000000 --- a/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicies-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api resourcePolicies getAtlasResourcePolicies --version 2024-08-05 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicy-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicy-2024-08-05-default.sh deleted file mode 100644 index 5fdb11d6f7..0000000000 --- a/docs/command/includes/atlas-api-resourcePolicies-getAtlasResourcePolicy-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api resourcePolicies getAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-getOrgResourcePolicy-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-getOrgResourcePolicy-2024-08-05-default.sh new file mode 100644 index 0000000000..25378ffc59 --- /dev/null +++ b/docs/command/includes/atlas-api-resourcePolicies-getOrgResourcePolicy-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api resourcePolicies getOrgResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-listOrgResourcePolicies-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-listOrgResourcePolicies-2024-08-05-default.sh new file mode 100644 index 0000000000..5385d089fc --- /dev/null +++ b/docs/command/includes/atlas-api-resourcePolicies-listOrgResourcePolicies-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api resourcePolicies listOrgResourcePolicies --version 2024-08-05 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-teams-getProjectTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-getProjectTeam-2023-01-01-default.sh new file mode 100644 index 0000000000..51a438290f --- /dev/null +++ b/docs/command/includes/atlas-api-teams-getProjectTeam-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams getProjectTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] diff --git a/internal/api/commands.go b/internal/api/commands.go index 7ee89fc38a..8dd6ac4269 100644 --- a/internal/api/commands.go +++ b/internal/api/commands.go @@ -22160,7 +22160,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c { OperationID: `getOrganizationSettings`, Aliases: nil, - Description: `Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Returns details about the specified organization's settings. 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. @@ -27722,18 +27722,312 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + { + Name: `Query Shape Insights`, + Description: ``, + Commands: []shared_api.Command{ + { + OperationID: `getGroupClusterQueryShapeInsightDetails`, + Aliases: nil, + Description: `Returns the metadata and statistics summary for a given query shape hash. + +This command 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: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details`, + QueryParameters: []shared_api.Parameter{ + { + Name: `envelope`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `since`, + Description: `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. + + + +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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `until`, + Description: `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. + + + +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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `processIds`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ + { + Name: `groupId`, + Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + Aliases: []string{`projectId`}, + }, + { + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `queryShapeHash`, + Description: `A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2025, 3, 12), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getGroupClusterQueryShapeInsightSummaries`, + Aliases: nil, + Description: `Returns a list of query shape statistics summaries for a given cluster. 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: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries`, + QueryParameters: []shared_api.Parameter{ + { + Name: `since`, + Description: `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. + + + +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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `until`, + Description: `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. + + + +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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `processIds`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `namespaces`, + Description: `Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as .: .. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `commands`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `nSummaries`, + Description: `Maximum number of query statistic summaries to return.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `series`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `queryShapeHashes`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `envelope`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ + { + Name: `groupId`, + Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + Aliases: []string{`projectId`}, + }, + { + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2025, 3, 12), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + }, + }, { Name: `Resource Policies`, Description: `Configure and manage Atlas Resource Policies within your organization.`, Commands: []shared_api.Command{ { - OperationID: `createAtlasResourcePolicy`, + OperationID: `createOrgResourcePolicy`, Aliases: nil, Description: `Create one Atlas Resource Policy for an 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-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: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-createAtlasResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-createOrgResourcePolicy/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies`, QueryParameters: []shared_api.Parameter{ @@ -27783,13 +28077,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteAtlasResourcePolicy`, + OperationID: `deleteOrgResourcePolicy`, Aliases: nil, Description: `Delete one Atlas Resource Policy for an 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-deleteatlasresourcepolicy. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgresourcepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}`, QueryParameters: []shared_api.Parameter{ @@ -27849,15 +28143,15 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getAtlasResourcePolicies`, + OperationID: `getOrgResourcePolicy`, Aliases: nil, - Description: `Return all Atlas Resource Policies for the org. + Description: `Return one Atlas Resource Policy for an 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-getatlasresourcepolicies. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgresourcepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getAtlasResourcePolicies/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getOrgResourcePolicy/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies`, + URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -27891,6 +28185,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `resourcePolicyId`, + Description: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -27905,15 +28209,15 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getAtlasResourcePolicy`, + OperationID: `getResourcesNonCompliant`, Aliases: nil, - Description: `Return one Atlas Resource Policy for an org. + Description: `Return all non-compliant resources for an 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-getatlasresourcepolicy. +This command 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: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getAtlasResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getResourcesNonCompliant/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}`, + URL: `/api/atlas/v2/orgs/{orgId}/nonCompliantResources`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -27947,16 +28251,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `resourcePolicyId`, - Description: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -27971,15 +28265,15 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getResourcesNonCompliant`, + OperationID: `listOrgResourcePolicies`, Aliases: nil, - Description: `Return all non-compliant resources for an org. + Description: `Return all Atlas Resource Policies for the 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-getresourcesnoncompliant. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgresourcepolicies. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getResourcesNonCompliant/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-listOrgResourcePolicies/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/nonCompliantResources`, + URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28027,13 +28321,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateAtlasResourcePolicy`, + OperationID: `updateOrgResourcePolicy`, Aliases: nil, Description: `Update one Atlas Resource Policy for an 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-updateatlasresourcepolicy. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgresourcepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-updateOrgResourcePolicy/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}`, QueryParameters: []shared_api.Parameter{ @@ -33970,6 +34264,76 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, + { + OperationID: `getProjectTeam`, + Aliases: nil, + Description: `Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting 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-getprojectteam. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getProjectTeam/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/teams/{teamId}`, + QueryParameters: []shared_api.Parameter{ + { + Name: `envelope`, + Description: `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.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ + { + Name: `groupId`, + Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + Aliases: []string{`projectId`}, + }, + { + Name: `teamId`, + Description: `Unique 24-hexadecimal digit string that identifies the team for which you want to get.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, { OperationID: `getTeamById`, Aliases: nil, diff --git a/tools/cmd/docs/metadata.go b/tools/cmd/docs/metadata.go index f497d3d453..d490947f52 100644 --- a/tools/cmd/docs/metadata.go +++ b/tools/cmd/docs/metadata.go @@ -348,20 +348,6 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createAtlasResourcePolicy`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: nil, - }, `createAtlasSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { @@ -1270,6 +1256,20 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, + `createOrgResourcePolicy`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + Examples: nil, + }, `createOrganization`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -2241,33 +2241,6 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteAtlasResourcePolicy`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - `resourcePolicyId`: { - Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, - - Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, `deleteAtlasSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { @@ -2851,6 +2824,33 @@ var metadata = metadatatypes.Metadata{ }, }, }, + `deleteOrgResourcePolicy`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `resourcePolicyId`: { + Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2024-08-05`: {{ + Source: `-`, + + Flags: map[string]string{ + `orgId`: `4888442a3354817a7320eb61`, + `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, `deleteOrganization`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -4329,56 +4329,6 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getAtlasResourcePolicies`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, - - Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - }, - }, - }, - }, - }, - `getAtlasResourcePolicy`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - `resourcePolicyId`: { - Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, - - Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, `getAtlasSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { @@ -5544,6 +5494,113 @@ var metadata = metadatatypes.Metadata{ }, }, }, + `getGroupClusterQueryShapeInsightDetails`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, + }, + `envelope`: { + Usage: `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`: { + Usage: `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.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `processIds`: { + Usage: `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`: { + Usage: `A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.`, + }, + `since`: { + Usage: `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`: { + Usage: `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.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2025-03-12`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `queryShapeHash`: `[queryShapeHash]`, + }, + }, + }, + }, + }, + `getGroupClusterQueryShapeInsightSummaries`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, + }, + `commands`: { + Usage: `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`: { + Usage: `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`: { + Usage: `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.`, + }, + `nSummaries`: { + Usage: `Maximum number of query statistic summaries to return.`, + }, + `namespaces`: { + Usage: `Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `processIds`: { + Usage: `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`: { + Usage: `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`: { + Usage: `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`: { + Usage: `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`: { + Usage: `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.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2025-03-12`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, `getHostLogs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `endDate`: { @@ -6096,6 +6153,33 @@ var metadata = metadatatypes.Metadata{ }, }, }, + `getOrgResourcePolicy`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `resourcePolicyId`: { + Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2024-08-05`: {{ + Source: `-`, + + Flags: map[string]string{ + `orgId`: `4888442a3354817a7320eb61`, + `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, `getOrganization`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -6800,6 +6884,35 @@ var metadata = metadatatypes.Metadata{ }, }, }, + `getProjectTeam`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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`: { + Usage: `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.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `teamId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the team for which you want to get.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + `teamId`: `[teamId]`, + }, + }, + }, + }, + }, `getProjectUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -9109,6 +9222,29 @@ var metadata = metadatatypes.Metadata{ }, }, }, + `listOrgResourcePolicies`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2024-08-05`: {{ + Source: `-`, + + Flags: map[string]string{ + `orgId`: `4888442a3354817a7320eb61`, + }, + }, + }, + }, + }, `listOrganizationEvents`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -11884,23 +12020,6 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateAtlasResourcePolicy`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - `resourcePolicyId`: { - Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, - }, - }, - Examples: nil, - }, `updateAtlasSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { @@ -12328,6 +12447,23 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, + `updateOrgResourcePolicy`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `envelope`: { + Usage: `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.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `resourcePolicyId`: { + Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, + }, + }, + Examples: nil, + }, `updateOrganization`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { diff --git a/tools/internal/specs/spec-with-overlays.yaml b/tools/internal/specs/spec-with-overlays.yaml index 1ab06cb8ca..ef6e449667 100644 --- a/tools/internal/specs/spec-with-overlays.yaml +++ b/tools/internal/specs/spec-with-overlays.yaml @@ -251,6 +251,17 @@ components: schema: $ref: '#/components/schemas/ApiError' description: Payment Required. + tooManyRequests: + content: + application/json: + example: + detail: (This is just an example, the exception may not be related to this endpoint) + error: 429 + errorCode: RATE_LIMITED + reason: Too Many Requests + schema: + $ref: '#/components/schemas/ApiError' + description: Too Many Requests. unauthorized: content: application/json: @@ -539,6 +550,7 @@ components: - AP_SOUTH_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 + - AP_NORTHEAST_2 type: string type: object type: object @@ -571,6 +583,7 @@ components: - AP_SOUTH_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 + - AP_NORTHEAST_2 readOnly: true type: string type: object @@ -909,6 +922,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -1965,6 +1984,7 @@ components: - SAOPAULO_BRA - MONTREAL_CAN - TOKYO_JPN + - SEOUL_KOR - SINGAPORE_SGP type: string ApiAtlasFTSAnalyzersViewManual: @@ -3578,6 +3598,7 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + - SAOPAULO_BRA type: string AtlasDataFederationGCPRegion: description: Atlas Data Federation GCP Regions. @@ -4621,6 +4642,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH externalDocs: description: Azure url: https://docs.atlas.mongodb.com/reference/microsoft-azure/ @@ -4696,6 +4723,7 @@ components: enum: - US_EAST_2 - EUROPE_WEST + - BRAZIL_SOUTH type: string type: object type: object @@ -4708,6 +4736,7 @@ components: enum: - US_EAST_2 - EUROPE_WEST + - BRAZIL_SOUTH readOnly: true type: string type: object @@ -4945,6 +4974,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -8019,6 +8054,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Google Compute Regions. @@ -8205,6 +8246,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Google Compute Regions. @@ -9579,14 +9626,12 @@ components: type: string caseLevel: default: false - description: | + description: |- Flag that indicates whether to include case comparison when `"strength" : 1` or `"strength" : 2`. - - | Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include | - |---|---|---|---| - | true | Yes | 1 | Base characters and case. | - | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. | - | false | No | | | + - `true` - Include casing in comparison + - Strength Level: 1 - Base characters and case. + - Strength Level: 2 - Base characters, diacritics (and possible other secondary differences), and case. + - `false` - Case is NOT included in comparison. type: boolean locale: description: 'International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `"locale" : "simple"`.' @@ -9721,16 +9766,16 @@ components: type: boolean strength: default: 3 - description: | - Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values: - - | Value | Comparison Level | Comparison Method | - |---|---|---| - | 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. | - | 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. | - | 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. | - | 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. | - | 5 | Identical | Compares for the specific use case of tie breaker. | + description: |- + Degree of comparison to perform when sorting words. + + MongoDB Cloud accepts the following _numeric values_ that correspond to the _comparison level_ and what that _comparison method_ is. + + - `1` - "Primary" - Compares the base characters only, ignoring other differences such as diacritics and case. + - `2` - "Secondary" - Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. + - `3` - "Tertiary" - Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. + - `4` - "Quaternary" - Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. + - `5` - "Identical" - Compares for the specific use case of tie breaker. format: int32 maximum: 5 minimum: 1 @@ -12232,6 +12277,10 @@ components: default: false description: Toggle sending database metrics that includes database names and metrics on the number of collections, storage size, and index size. type: boolean + sendUserProvidedResourceTags: + default: false + description: Toggle sending user provided group and cluster resource tags with the datadog metrics. + type: boolean type: description: Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. enum: @@ -12458,6 +12507,8 @@ components: - NETWORK_PERMISSION_ENTRY_ADDED - NETWORK_PERMISSION_ENTRY_REMOVED - NETWORK_PERMISSION_ENTRY_UPDATED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE title: NDS Audit Types type: string - enum: @@ -12661,6 +12712,8 @@ components: - NETWORK_PERMISSION_ENTRY_ADDED - NETWORK_PERMISSION_ENTRY_REMOVED - NETWORK_PERMISSION_ENTRY_UPDATED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE title: NDS Audit Types type: string - enum: @@ -13290,6 +13343,14 @@ components: - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED - GCP_SELF_SERVE_ACCOUNT_LINKED - GCP_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINKED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING + - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED + - VERCEL_INVOICE_CREATED + - VERCEL_INVOICE_NOT_PAID + - VERCEL_INVOICE_PAID + - VERCEL_INVOICE_REFUNDED title: Partner Event Types type: string - enum: @@ -13420,7 +13481,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13429,7 +13490,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13458,7 +13519,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13608,7 +13669,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string shouldCopyOplogs: @@ -13651,7 +13712,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster From One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string required: @@ -14788,6 +14849,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -15577,6 +15644,8 @@ components: - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED - CLUSTER_INSTANCE_DISABLED - CLUSTER_INSTANCE_ENABLED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE - KMIP_KEY_ROTATION_SCHEDULED - SSL_CERTIFICATE_ISSUED - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS @@ -15588,6 +15657,7 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED + - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED title: NDS Audit Types type: string - enum: @@ -16002,6 +16072,7 @@ components: type: string - enum: - ORG_CREATED + - CUSTOM_SESSION_TIMEOUT_MODIFIED - SECURITY_CONTACT_MODIFIED - ORG_CREDIT_CARD_ADDED - ORG_CREDIT_CARD_UPDATED @@ -16057,6 +16128,8 @@ components: - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED - GROUP_MOVED_FROM_ORG + - SANDBOX_ENABLED_FOR_ORG + - SANDBOX_DISABLED_FOR_ORG title: Org Event Types type: string - enum: @@ -16072,6 +16145,14 @@ components: - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED - GCP_SELF_SERVE_ACCOUNT_LINKED - GCP_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINKED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING + - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED + - VERCEL_INVOICE_CREATED + - VERCEL_INVOICE_NOT_PAID + - VERCEL_INVOICE_PAID + - VERCEL_INVOICE_REFUNDED title: Partner Event Types type: string - enum: @@ -18238,6 +18319,11 @@ components: description: Resource path that displays the key version resource ID for your Google Cloud KMS. example: projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1 type: string + roleId: + description: Unique 24-hexadecimal digit string that identifies the Google Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud KMS. + example: 32b6e34b3d91647abb20e7b8 + pattern: ^([a-f0-9]{24})$ + type: string serviceAccountKey: description: JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object. externalDocs: @@ -21286,6 +21372,11 @@ components: - ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP10 + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP30 + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP50 + - ATLAS_GCP_STREAM_PROCESSING_DATA_TRANSFER + - ATLAS_GCP_STREAM_PROCESSING_PRIVATELINK readOnly: true type: string startDate: @@ -23281,6 +23372,8 @@ components: - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED - CLUSTER_INSTANCE_DISABLED - CLUSTER_INSTANCE_ENABLED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE - KMIP_KEY_ROTATION_SCHEDULED - SSL_CERTIFICATE_ISSUED - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS @@ -23292,6 +23385,7 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED + - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED example: CLUSTER_CREATED title: NDS Audit Types type: string @@ -24511,6 +24605,7 @@ components: description: Unique identifier of event type. enum: - ORG_CREATED + - CUSTOM_SESSION_TIMEOUT_MODIFIED - SECURITY_CONTACT_MODIFIED - ORG_CREDIT_CARD_ADDED - ORG_CREDIT_CARD_UPDATED @@ -24566,6 +24661,8 @@ components: - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED - GROUP_MOVED_FROM_ORG + - SANDBOX_ENABLED_FOR_ORG + - SANDBOX_DISABLED_FOR_ORG example: ORG_CREATED title: Org Event Types type: string @@ -27624,6 +27721,117 @@ components: readOnly: true type: string type: object + QueryShapeSeenMetadata: + description: Metadata about when a query shape was seen. + properties: + applicationName: + description: The name of the application that this query shape came from. This can be set via the MongoDB connection string. The application name is set to unknown for internal MongoDB queries. + type: string + driverName: + description: The name of the MongoDB driver that this query shape was executed from. The driver name is set to unknown for internal MongoDB queries. + type: string + driverVersion: + description: The version of the MongoDB driver that this query shape was executed from. The driver version is set to unknown for internal MongoDB queries. + type: string + timestamp: + description: Unix epoch milliseconds of the time. + format: int64 + type: integer + type: object + QueryStatsDetailsResponse: + description: Metadata and summary statistics for a given query shape. + properties: + firstSeen: + $ref: '#/components/schemas/QueryShapeSeenMetadata' + lastSeen: + $ref: '#/components/schemas/QueryShapeSeenMetadata' + queryStats: + $ref: '#/components/schemas/QueryStatsSummary' + type: object + QueryStatsSummary: + description: A summary of execution statistics for a given query shape. + properties: + avgWorkingMillis: + description: Average total time in milliseconds spent running queries with the given query shape. If the query resulted in getMore commands, this metric includes the time spent processing the getMore requests. This metric does not include time spent waiting for the client. + format: double + type: number + bytesRead: + description: The number of bytes read by the given query shape from the disk to the cache. + format: double + type: number + command: + description: The MongoDB command issued for this query shape. + enum: + - find + - distinct + - aggregate + type: string + docsExamined: + description: Total number of documents examined by queries with the given query shape. + format: double + type: number + docsExaminedRatio: + description: Ratio of documents examined to documents returned by queries with the given query shape. + format: double + type: number + docsReturned: + description: Total number of documents returned by queries with the given query shape. + format: double + type: number + execCount: + description: Total number of times that queries with the given query shape have been executed. + format: double + type: number + keysExamined: + description: Total number of in-bounds and out-of-bounds index keys examined by queries with the given query shape. + format: double + type: number + keysExaminedRatio: + description: Ratio of in-bounds and out-of-bounds index keys examined to indexes containing documents returned by queries with the given query shape. + format: double + type: number + lastExecMicros: + description: Execution runtime in microseconds for the most recent query with the given query shape. + format: double + type: number + namespace: + description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. + type: string + p50ExecMicros: + description: The 50th percentile value of execution time in microseconds. + format: double + type: number + p90ExecMicros: + description: The 90th percentile value of execution time in microseconds. + format: double + type: number + p99ExecMicros: + description: The 99th percentile value of execution time in microseconds. + format: double + type: number + queryShape: + description: A query shape is a set of specifications that group similar queries together. Specifications can include filters, sorts, projections, aggregation pipeline stages, a namespace, and others. Queries that have similar specifications have the same query shape. + type: string + queryShapeHash: + description: A hexadecimal string that represents the hash of a MongoDB query shape. + type: string + totalTimeToResponseMicros: + description: Time in microseconds spent from the beginning of query processing to the first server response. + format: double + type: number + totalWorkingMillis: + description: Total time in milliseconds spent running queries with the given query shape. If the query resulted in `getMore` commands, this metric includes the time spent processing the `getMore` requests. This metric does not include time spent waiting for the client. + format: double + type: number + type: object + QueryStatsSummaryListResponse: + properties: + summaries: + description: List of query shape statistic summaries from Query Shape Insights. + items: + $ref: '#/components/schemas/QueryStatsSummary' + type: array + type: object RPUMetricThresholdView: properties: metricName: @@ -31026,6 +31234,17 @@ components: description: The name of an S3 bucket used to check authorization of the passed-in IAM role ARN. type: string type: object + StreamsAWSKinesisDataStreamsConnection: + allOf: + - $ref: '#/components/schemas/StreamsConnection' + - properties: + aws: + $ref: '#/components/schemas/StreamsAWSConnectionConfig' + networking: + $ref: '#/components/schemas/StreamsKafkaNetworking' + type: object + description: The configuration for AWS Kinesis Data Stream connections. + type: object StreamsAWSLambdaConnection: allOf: - $ref: '#/components/schemas/StreamsConnection' @@ -31053,6 +31272,7 @@ components: description: Settings that define a connection to an external data store. discriminator: mapping: + AWSKinesisDataStreams: '#/components/schemas/StreamsAWSKinesisDataStreamsConnection' AWSLambda: '#/components/schemas/StreamsAWSLambdaConnection' Cluster: '#/components/schemas/StreamsClusterConnection' Https: '#/components/schemas/StreamsHttpsConnection' @@ -31067,6 +31287,7 @@ components: - $ref: '#/components/schemas/StreamsHttpsConnection' - $ref: '#/components/schemas/StreamsAWSLambdaConnection' - $ref: '#/components/schemas/StreamsS3Connection' + - $ref: '#/components/schemas/StreamsAWSKinesisDataStreamsConnection' properties: links: description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. @@ -31088,6 +31309,7 @@ components: - Sample - Https - AWSLambda + - AWSKinesisDataStreams type: string readOnly: true type: object @@ -31278,7 +31500,7 @@ components: type: object type: object StreamsKafkaNetworking: - description: Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access. + description: Networking configuration for Streams connections. properties: access: $ref: '#/components/schemas/StreamsKafkaNetworkingAccess' @@ -31293,7 +31515,7 @@ components: type: array type: object StreamsKafkaNetworkingAccess: - description: Information about the networking access. + description: Information about networking access. properties: connectionId: description: Reserved. Will be used by PRIVATE_LINK connection type. @@ -31515,11 +31737,17 @@ components: type: string vendor: description: |- - Vendor that manages the Kafka cluster. The following are the vendor values per provider: - - MSK and CONFLUENT for the AWS provider. - - EVENTHUB and CONFLUENT for the AZURE provider. + Vendor that manages the cloud service. The following are the vendor values per provider: + - AWS + -- MSK for AWS MSK Kafka clusters + -- CONFLUENT for Confluent Kafka clusters on AWS + -- KINESIS for AWS Kinesis Data Streams (coming soon). + + - Azure + -- EVENTHUB for Azure EventHub. + -- CONFLUENT for the Confluent Kafka clusters on Azure - **NOTE** Omitting the vendor field will default to using the EVENTHUB vendor for the AZURE provider. + **NOTE** Omitting the vendor field will default to using the GENERIC vendor. type: string required: - provider @@ -34795,7 +35023,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 26cadc643a40bc7ede7b258112a0df72164b9ce2 + x-xgen-sha: 7ebc356024c9b5ce4badb8d04f552f5be6435c79 openapi: 3.0.1 paths: /api/atlas/v2: @@ -37524,7 +37752,7 @@ paths: description: |- Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters @@ -37841,7 +38069,7 @@ paths: description: |- Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster @@ -37915,7 +38143,7 @@ paths: description: |- Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster @@ -39101,7 +39329,7 @@ paths: description: |- Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. externalDocs: description: downloadFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup @@ -39155,7 +39383,7 @@ paths: description: |- Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob @@ -39209,7 +39437,7 @@ paths: description: |- Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs @@ -39254,7 +39482,7 @@ paths: description: |- Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob @@ -39306,7 +39534,7 @@ paths: description: |- Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. + This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups @@ -39351,7 +39579,7 @@ paths: description: |- Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup @@ -40321,6 +40549,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Create One Rolling Index @@ -40859,6 +41089,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes to Drop @@ -40894,6 +41126,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Schema Advice @@ -40972,6 +41206,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes @@ -41083,6 +41319,232 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details: + get: + description: Returns the metadata and statistics summary for a given query shape hash. + operationId: getGroupClusterQueryShapeInsightDetails + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/pretty' + - $ref: '#/components/parameters/groupId' + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + type: string + - description: |- + 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. + in: query + name: since + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: |- + 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. + in: query + name: until + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: 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. + in: query + name: processIds + schema: + items: + pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$ + type: string + maxItems: 10 + type: array + style: form + - description: A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs. + in: path + name: queryShapeHash + required: true + schema: + pattern: ^([a-fA-F0-9]{64})$ + type: string + responses: + "200": + content: + application/vnd.atlas.2025-03-12+json: + schema: + $ref: '#/components/schemas/QueryStatsDetailsResponse' + x-xgen-version: "2025-03-12" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return Query Shape Details + tags: + - Query Shape Insights + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightDetails + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries: + get: + description: Returns a list of query shape statistics summaries for a given cluster. Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations. + operationId: getGroupClusterQueryShapeInsightSummaries + parameters: + - $ref: '#/components/parameters/groupId' + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + type: string + - description: |- + 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. + in: query + name: since + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: |- + 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. + in: query + name: until + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: 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. + in: query + name: processIds + schema: + items: + pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$ + type: string + maxItems: 10 + type: array + style: form + - description: 'Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.' + in: query + name: namespaces + schema: + items: + type: string + maxItems: 10 + type: array + style: form + - description: 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. + in: query + name: commands + schema: + description: MongoDB commands from which to retrieve query statistics. To include multiple commands, pass the parameter multiple times delimited with an ampersand (`&`) between each command. Omit this parameter to return results for all supported commands. + items: + enum: + - find + - distinct + - aggregate + type: string + maxItems: 3 + type: array + uniqueItems: true + style: form + - description: Maximum number of query statistic summaries to return. + in: query + name: nSummaries + schema: + default: 100 + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: 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. + in: query + name: series + schema: + description: 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. + items: + enum: + - TOTAL_EXECUTION_TIME + - AVG_EXECUTION_TIME + - EXECUTION_COUNT + - KEYS_EXAMINED + - DOCS_EXAMINED + - DOCS_RETURNED + - TOTAL_TIME_TO_RESPONSE + - BYTES_READ + - KEYS_EXAMINED_RETURNED + - DOCS_EXAMINED_RETURNED + - LAST_EXECUTION_TIME + - P50_EXECUTION_TIME + - P90_EXECUTION_TIME + - P99_EXECUTION_TIME + type: string + maxItems: 14 + type: array + uniqueItems: true + style: form + - description: 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. + in: query + name: queryShapeHashes + schema: + description: 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. + items: + pattern: ^([a-fA-F0-9]{64})$ + type: string + maxItems: 10 + type: array + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2025-03-12+json: + schema: + $ref: '#/components/schemas/QueryStatsSummaryListResponse' + x-xgen-version: "2025-03-12" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return Query Statistic Summaries + tags: + - Query Shape Insights + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightSummaries /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: description: Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. @@ -42650,7 +43112,7 @@ paths: x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: - description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. 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. \n\nThis endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead." + description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. 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. \n\nThis endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead." externalDocs: description: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster @@ -44153,6 +44615,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Database Access History for One Cluster by Cluster Name @@ -44222,6 +44686,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Database Access History for One Cluster by Hostname @@ -44567,6 +45033,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Events from One Project @@ -45193,6 +45661,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Atlas Search Metric Types for One Process @@ -45255,6 +45725,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Atlas Search Metrics for One Index in One Namespace @@ -45316,6 +45788,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Atlas Search Index Metrics for One Namespace @@ -45374,6 +45848,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Atlas Search Hardware and Status Metrics @@ -46522,6 +46998,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Managed Slow Operation Threshold Status @@ -46548,6 +47026,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Disable Managed Slow Operation Threshold @@ -46574,6 +47054,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Enable Managed Slow Operation Threshold @@ -49141,6 +49623,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Namespaces for One Host @@ -49234,6 +49718,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Slow Queries @@ -49316,6 +49802,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes @@ -49915,6 +50403,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Serverless Auto-Indexing Status @@ -49955,6 +50445,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Set Serverless Auto-Indexing Status @@ -52042,7 +52534,7 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Add Teams to One Project + summary: Add One Team to One Project tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject @@ -52087,6 +52579,44 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + get: + description: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + operationId: getProjectTeam + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/groupId' + - description: Unique 24-hexadecimal digit string that identifies the team for which you want to get. + in: path + name: teamId + required: true + schema: + pattern: ^([a-f0-9]{24})$ + type: string + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2023-01-01+json: + schema: + $ref: '#/components/schemas/TeamRole' + x-xgen-IPA-exception: + xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation + x-xgen-version: "2023-01-01" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return One Team in One Project + tags: + - Teams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getProjectTeam patch: description: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: @@ -52117,6 +52647,8 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedTeamRoleView' + x-xgen-IPA-exception: + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation x-xgen-version: "2023-01-01" description: OK "400": @@ -54309,7 +54841,7 @@ paths: externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getAtlasResourcePolicies + operationId: listOrgResourcePolicies parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54343,13 +54875,13 @@ paths: summary: Return All Atlas Resource Policies tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/listOrgResourcePolicies post: description: Create one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: createAtlasResourcePolicy + operationId: createOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54388,14 +54920,14 @@ paths: summary: Create One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createOrgResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: delete: description: Delete one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: deleteAtlasResourcePolicy + operationId: deleteOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54429,13 +54961,13 @@ paths: summary: Delete One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteOrgResourcePolicy get: description: Return one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getAtlasResourcePolicy + operationId: getOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54473,13 +55005,13 @@ paths: summary: Return One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgResourcePolicy patch: description: Update one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: updateAtlasResourcePolicy + operationId: updateOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54528,7 +55060,7 @@ paths: summary: Update One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateOrgResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: post: description: Validate one Atlas Resource Policy for an org. @@ -55020,7 +55552,7 @@ paths: x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret /api/atlas/v2/orgs/{orgId}/settings: get: - description: Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + description: Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Member role. operationId: getOrganizationSettings parameters: - $ref: '#/components/parameters/envelope' @@ -55078,6 +55610,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Update Settings for One Organization diff --git a/tools/internal/specs/spec.yaml b/tools/internal/specs/spec.yaml index aa58ad577b..1c10fe0704 100644 --- a/tools/internal/specs/spec.yaml +++ b/tools/internal/specs/spec.yaml @@ -248,6 +248,17 @@ components: schema: $ref: '#/components/schemas/ApiError' description: Payment Required. + tooManyRequests: + content: + application/json: + example: + detail: (This is just an example, the exception may not be related to this endpoint) + error: 429 + errorCode: RATE_LIMITED + reason: Too Many Requests + schema: + $ref: '#/components/schemas/ApiError' + description: Too Many Requests. unauthorized: content: application/json: @@ -536,6 +547,7 @@ components: - AP_SOUTH_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 + - AP_NORTHEAST_2 type: string type: object type: object @@ -568,6 +580,7 @@ components: - AP_SOUTH_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 + - AP_NORTHEAST_2 readOnly: true type: string type: object @@ -906,6 +919,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -1962,6 +1981,7 @@ components: - SAOPAULO_BRA - MONTREAL_CAN - TOKYO_JPN + - SEOUL_KOR - SINGAPORE_SGP type: string ApiAtlasFTSAnalyzersViewManual: @@ -3575,6 +3595,7 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + - SAOPAULO_BRA type: string AtlasDataFederationGCPRegion: description: Atlas Data Federation GCP Regions. @@ -4618,6 +4639,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH externalDocs: description: Azure url: https://docs.atlas.mongodb.com/reference/microsoft-azure/ @@ -4693,6 +4720,7 @@ components: enum: - US_EAST_2 - EUROPE_WEST + - BRAZIL_SOUTH type: string type: object type: object @@ -4705,6 +4733,7 @@ components: enum: - US_EAST_2 - EUROPE_WEST + - BRAZIL_SOUTH readOnly: true type: string type: object @@ -4942,6 +4971,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -8016,6 +8051,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Google Compute Regions. @@ -8202,6 +8243,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Google Compute Regions. @@ -9576,14 +9623,12 @@ components: type: string caseLevel: default: false - description: | + description: |- Flag that indicates whether to include case comparison when `"strength" : 1` or `"strength" : 2`. - - | Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include | - |---|---|---|---| - | true | Yes | 1 | Base characters and case. | - | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. | - | false | No | | | + - `true` - Include casing in comparison + - Strength Level: 1 - Base characters and case. + - Strength Level: 2 - Base characters, diacritics (and possible other secondary differences), and case. + - `false` - Case is NOT included in comparison. type: boolean locale: description: 'International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `"locale" : "simple"`.' @@ -9718,16 +9763,16 @@ components: type: boolean strength: default: 3 - description: | - Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values: - - | Value | Comparison Level | Comparison Method | - |---|---|---| - | 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. | - | 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. | - | 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. | - | 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. | - | 5 | Identical | Compares for the specific use case of tie breaker. | + description: |- + Degree of comparison to perform when sorting words. + + MongoDB Cloud accepts the following _numeric values_ that correspond to the _comparison level_ and what that _comparison method_ is. + + - `1` - "Primary" - Compares the base characters only, ignoring other differences such as diacritics and case. + - `2` - "Secondary" - Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. + - `3` - "Tertiary" - Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. + - `4` - "Quaternary" - Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. + - `5` - "Identical" - Compares for the specific use case of tie breaker. format: int32 maximum: 5 minimum: 1 @@ -12229,6 +12274,10 @@ components: default: false description: Toggle sending database metrics that includes database names and metrics on the number of collections, storage size, and index size. type: boolean + sendUserProvidedResourceTags: + default: false + description: Toggle sending user provided group and cluster resource tags with the datadog metrics. + type: boolean type: description: Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. enum: @@ -12455,6 +12504,8 @@ components: - NETWORK_PERMISSION_ENTRY_ADDED - NETWORK_PERMISSION_ENTRY_REMOVED - NETWORK_PERMISSION_ENTRY_UPDATED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE title: NDS Audit Types type: string - enum: @@ -12658,6 +12709,8 @@ components: - NETWORK_PERMISSION_ENTRY_ADDED - NETWORK_PERMISSION_ENTRY_REMOVED - NETWORK_PERMISSION_ENTRY_UPDATED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE title: NDS Audit Types type: string - enum: @@ -13287,6 +13340,14 @@ components: - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED - GCP_SELF_SERVE_ACCOUNT_LINKED - GCP_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINKED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING + - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED + - VERCEL_INVOICE_CREATED + - VERCEL_INVOICE_NOT_PAID + - VERCEL_INVOICE_PAID + - VERCEL_INVOICE_REFUNDED title: Partner Event Types type: string - enum: @@ -13417,7 +13478,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13426,7 +13487,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13455,7 +13516,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true @@ -13605,7 +13666,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string shouldCopyOplogs: @@ -13648,7 +13709,7 @@ components: example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster From One Project - url: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster + url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string required: @@ -14785,6 +14846,12 @@ components: - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL + - POLAND_CENTRAL + - ISRAEL_CENTRAL + - ITALY_NORTH + - SPAIN_CENTRAL + - MEXICO_CENTRAL + - NEW_ZEALAND_NORTH title: Azure Regions type: string - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. @@ -15574,6 +15641,8 @@ components: - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED - CLUSTER_INSTANCE_DISABLED - CLUSTER_INSTANCE_ENABLED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE - KMIP_KEY_ROTATION_SCHEDULED - SSL_CERTIFICATE_ISSUED - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS @@ -15585,6 +15654,7 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED + - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED title: NDS Audit Types type: string - enum: @@ -15999,6 +16069,7 @@ components: type: string - enum: - ORG_CREATED + - CUSTOM_SESSION_TIMEOUT_MODIFIED - SECURITY_CONTACT_MODIFIED - ORG_CREDIT_CARD_ADDED - ORG_CREDIT_CARD_UPDATED @@ -16054,6 +16125,8 @@ components: - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED - GROUP_MOVED_FROM_ORG + - SANDBOX_ENABLED_FOR_ORG + - SANDBOX_DISABLED_FOR_ORG title: Org Event Types type: string - enum: @@ -16069,6 +16142,14 @@ components: - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED - GCP_SELF_SERVE_ACCOUNT_LINKED - GCP_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINKED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING + - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED + - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED + - VERCEL_INVOICE_CREATED + - VERCEL_INVOICE_NOT_PAID + - VERCEL_INVOICE_PAID + - VERCEL_INVOICE_REFUNDED title: Partner Event Types type: string - enum: @@ -18235,6 +18316,11 @@ components: description: Resource path that displays the key version resource ID for your Google Cloud KMS. example: projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1 type: string + roleId: + description: Unique 24-hexadecimal digit string that identifies the Google Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud KMS. + example: 32b6e34b3d91647abb20e7b8 + pattern: ^([a-f0-9]{24})$ + type: string serviceAccountKey: description: JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object. externalDocs: @@ -21283,6 +21369,11 @@ components: - ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP10 + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP30 + - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP50 + - ATLAS_GCP_STREAM_PROCESSING_DATA_TRANSFER + - ATLAS_GCP_STREAM_PROCESSING_PRIVATELINK readOnly: true type: string startDate: @@ -23278,6 +23369,8 @@ components: - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED - CLUSTER_INSTANCE_DISABLED - CLUSTER_INSTANCE_ENABLED + - CLUSTER_BLOCK_WRITE + - CLUSTER_UNBLOCK_WRITE - KMIP_KEY_ROTATION_SCHEDULED - SSL_CERTIFICATE_ISSUED - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS @@ -23289,6 +23382,7 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED + - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED example: CLUSTER_CREATED title: NDS Audit Types type: string @@ -24508,6 +24602,7 @@ components: description: Unique identifier of event type. enum: - ORG_CREATED + - CUSTOM_SESSION_TIMEOUT_MODIFIED - SECURITY_CONTACT_MODIFIED - ORG_CREDIT_CARD_ADDED - ORG_CREDIT_CARD_UPDATED @@ -24563,6 +24658,8 @@ components: - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED - GROUP_MOVED_FROM_ORG + - SANDBOX_ENABLED_FOR_ORG + - SANDBOX_DISABLED_FOR_ORG example: ORG_CREATED title: Org Event Types type: string @@ -27621,6 +27718,117 @@ components: readOnly: true type: string type: object + QueryShapeSeenMetadata: + description: Metadata about when a query shape was seen. + properties: + applicationName: + description: The name of the application that this query shape came from. This can be set via the MongoDB connection string. The application name is set to unknown for internal MongoDB queries. + type: string + driverName: + description: The name of the MongoDB driver that this query shape was executed from. The driver name is set to unknown for internal MongoDB queries. + type: string + driverVersion: + description: The version of the MongoDB driver that this query shape was executed from. The driver version is set to unknown for internal MongoDB queries. + type: string + timestamp: + description: Unix epoch milliseconds of the time. + format: int64 + type: integer + type: object + QueryStatsDetailsResponse: + description: Metadata and summary statistics for a given query shape. + properties: + firstSeen: + $ref: '#/components/schemas/QueryShapeSeenMetadata' + lastSeen: + $ref: '#/components/schemas/QueryShapeSeenMetadata' + queryStats: + $ref: '#/components/schemas/QueryStatsSummary' + type: object + QueryStatsSummary: + description: A summary of execution statistics for a given query shape. + properties: + avgWorkingMillis: + description: Average total time in milliseconds spent running queries with the given query shape. If the query resulted in getMore commands, this metric includes the time spent processing the getMore requests. This metric does not include time spent waiting for the client. + format: double + type: number + bytesRead: + description: The number of bytes read by the given query shape from the disk to the cache. + format: double + type: number + command: + description: The MongoDB command issued for this query shape. + enum: + - find + - distinct + - aggregate + type: string + docsExamined: + description: Total number of documents examined by queries with the given query shape. + format: double + type: number + docsExaminedRatio: + description: Ratio of documents examined to documents returned by queries with the given query shape. + format: double + type: number + docsReturned: + description: Total number of documents returned by queries with the given query shape. + format: double + type: number + execCount: + description: Total number of times that queries with the given query shape have been executed. + format: double + type: number + keysExamined: + description: Total number of in-bounds and out-of-bounds index keys examined by queries with the given query shape. + format: double + type: number + keysExaminedRatio: + description: Ratio of in-bounds and out-of-bounds index keys examined to indexes containing documents returned by queries with the given query shape. + format: double + type: number + lastExecMicros: + description: Execution runtime in microseconds for the most recent query with the given query shape. + format: double + type: number + namespace: + description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. + type: string + p50ExecMicros: + description: The 50th percentile value of execution time in microseconds. + format: double + type: number + p90ExecMicros: + description: The 90th percentile value of execution time in microseconds. + format: double + type: number + p99ExecMicros: + description: The 99th percentile value of execution time in microseconds. + format: double + type: number + queryShape: + description: A query shape is a set of specifications that group similar queries together. Specifications can include filters, sorts, projections, aggregation pipeline stages, a namespace, and others. Queries that have similar specifications have the same query shape. + type: string + queryShapeHash: + description: A hexadecimal string that represents the hash of a MongoDB query shape. + type: string + totalTimeToResponseMicros: + description: Time in microseconds spent from the beginning of query processing to the first server response. + format: double + type: number + totalWorkingMillis: + description: Total time in milliseconds spent running queries with the given query shape. If the query resulted in `getMore` commands, this metric includes the time spent processing the `getMore` requests. This metric does not include time spent waiting for the client. + format: double + type: number + type: object + QueryStatsSummaryListResponse: + properties: + summaries: + description: List of query shape statistic summaries from Query Shape Insights. + items: + $ref: '#/components/schemas/QueryStatsSummary' + type: array + type: object RPUMetricThresholdView: properties: metricName: @@ -31023,6 +31231,17 @@ components: description: The name of an S3 bucket used to check authorization of the passed-in IAM role ARN. type: string type: object + StreamsAWSKinesisDataStreamsConnection: + allOf: + - $ref: '#/components/schemas/StreamsConnection' + - properties: + aws: + $ref: '#/components/schemas/StreamsAWSConnectionConfig' + networking: + $ref: '#/components/schemas/StreamsKafkaNetworking' + type: object + description: The configuration for AWS Kinesis Data Stream connections. + type: object StreamsAWSLambdaConnection: allOf: - $ref: '#/components/schemas/StreamsConnection' @@ -31050,6 +31269,7 @@ components: description: Settings that define a connection to an external data store. discriminator: mapping: + AWSKinesisDataStreams: '#/components/schemas/StreamsAWSKinesisDataStreamsConnection' AWSLambda: '#/components/schemas/StreamsAWSLambdaConnection' Cluster: '#/components/schemas/StreamsClusterConnection' Https: '#/components/schemas/StreamsHttpsConnection' @@ -31064,6 +31284,7 @@ components: - $ref: '#/components/schemas/StreamsHttpsConnection' - $ref: '#/components/schemas/StreamsAWSLambdaConnection' - $ref: '#/components/schemas/StreamsS3Connection' + - $ref: '#/components/schemas/StreamsAWSKinesisDataStreamsConnection' properties: links: description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. @@ -31085,6 +31306,7 @@ components: - Sample - Https - AWSLambda + - AWSKinesisDataStreams type: string readOnly: true type: object @@ -31275,7 +31497,7 @@ components: type: object type: object StreamsKafkaNetworking: - description: Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access. + description: Networking configuration for Streams connections. properties: access: $ref: '#/components/schemas/StreamsKafkaNetworkingAccess' @@ -31290,7 +31512,7 @@ components: type: array type: object StreamsKafkaNetworkingAccess: - description: Information about the networking access. + description: Information about networking access. properties: connectionId: description: Reserved. Will be used by PRIVATE_LINK connection type. @@ -31512,11 +31734,17 @@ components: type: string vendor: description: |- - Vendor that manages the Kafka cluster. The following are the vendor values per provider: - - MSK and CONFLUENT for the AWS provider. - - EVENTHUB and CONFLUENT for the AZURE provider. + Vendor that manages the cloud service. The following are the vendor values per provider: + - AWS + -- MSK for AWS MSK Kafka clusters + -- CONFLUENT for Confluent Kafka clusters on AWS + -- KINESIS for AWS Kinesis Data Streams (coming soon). + + - Azure + -- EVENTHUB for Azure EventHub. + -- CONFLUENT for the Confluent Kafka clusters on Azure - **NOTE** Omitting the vendor field will default to using the EVENTHUB vendor for the AZURE provider. + **NOTE** Omitting the vendor field will default to using the GENERIC vendor. type: string required: - provider @@ -34792,7 +35020,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 26cadc643a40bc7ede7b258112a0df72164b9ce2 + x-xgen-sha: 7ebc356024c9b5ce4badb8d04f552f5be6435c79 openapi: 3.0.1 paths: /api/atlas/v2: @@ -37389,7 +37617,7 @@ paths: description: |- Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters @@ -37664,7 +37892,7 @@ paths: description: |- Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster @@ -37714,7 +37942,7 @@ paths: description: |- Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster @@ -38793,7 +39021,7 @@ paths: description: |- Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. externalDocs: description: downloadFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup @@ -38847,7 +39075,7 @@ paths: description: |- Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob @@ -38901,7 +39129,7 @@ paths: description: |- Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs @@ -38946,7 +39174,7 @@ paths: description: |- Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob @@ -38998,7 +39226,7 @@ paths: description: |- Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. + This API also works for Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups @@ -39043,7 +39271,7 @@ paths: description: |- Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. + This endpoint can also be used on Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup @@ -40009,6 +40237,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Create One Rolling Index @@ -40477,6 +40707,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes to Drop @@ -40512,6 +40744,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Schema Advice @@ -40590,6 +40824,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes @@ -40701,6 +40937,232 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details: + get: + description: Returns the metadata and statistics summary for a given query shape hash. + operationId: getGroupClusterQueryShapeInsightDetails + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/pretty' + - $ref: '#/components/parameters/groupId' + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + type: string + - description: |- + 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. + in: query + name: since + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: |- + 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. + in: query + name: until + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: 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. + in: query + name: processIds + schema: + items: + pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$ + type: string + maxItems: 10 + type: array + style: form + - description: A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs. + in: path + name: queryShapeHash + required: true + schema: + pattern: ^([a-fA-F0-9]{64})$ + type: string + responses: + "200": + content: + application/vnd.atlas.2025-03-12+json: + schema: + $ref: '#/components/schemas/QueryStatsDetailsResponse' + x-xgen-version: "2025-03-12" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return Query Shape Details + tags: + - Query Shape Insights + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightDetails + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries: + get: + description: Returns a list of query shape statistics summaries for a given cluster. Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations. + operationId: getGroupClusterQueryShapeInsightSummaries + parameters: + - $ref: '#/components/parameters/groupId' + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + type: string + - description: |- + 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. + in: query + name: since + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: |- + 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. + in: query + name: until + schema: + format: int64 + minimum: 1.1991456e+12 + type: integer + x-xgen-IPA-exception: + xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs + - description: 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. + in: query + name: processIds + schema: + items: + pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$ + type: string + maxItems: 10 + type: array + style: form + - description: 'Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.' + in: query + name: namespaces + schema: + items: + type: string + maxItems: 10 + type: array + style: form + - description: 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. + in: query + name: commands + schema: + description: MongoDB commands from which to retrieve query statistics. To include multiple commands, pass the parameter multiple times delimited with an ampersand (`&`) between each command. Omit this parameter to return results for all supported commands. + items: + enum: + - find + - distinct + - aggregate + type: string + maxItems: 3 + type: array + uniqueItems: true + style: form + - description: Maximum number of query statistic summaries to return. + in: query + name: nSummaries + schema: + default: 100 + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: 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. + in: query + name: series + schema: + description: 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. + items: + enum: + - TOTAL_EXECUTION_TIME + - AVG_EXECUTION_TIME + - EXECUTION_COUNT + - KEYS_EXAMINED + - DOCS_EXAMINED + - DOCS_RETURNED + - TOTAL_TIME_TO_RESPONSE + - BYTES_READ + - KEYS_EXAMINED_RETURNED + - DOCS_EXAMINED_RETURNED + - LAST_EXECUTION_TIME + - P50_EXECUTION_TIME + - P90_EXECUTION_TIME + - P99_EXECUTION_TIME + type: string + maxItems: 14 + type: array + uniqueItems: true + style: form + - description: 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. + in: query + name: queryShapeHashes + schema: + description: 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. + items: + pattern: ^([a-fA-F0-9]{64})$ + type: string + maxItems: 10 + type: array + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2025-03-12+json: + schema: + $ref: '#/components/schemas/QueryStatsSummaryListResponse' + x-xgen-version: "2025-03-12" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return Query Statistic Summaries + tags: + - Query Shape Insights + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightSummaries /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: description: Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. @@ -42201,7 +42663,7 @@ paths: x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: - description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. 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. \n\nThis endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead." + description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. 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. \n\nThis endpoint can also be used to upgrade Flex clusters that were created using the [createCluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead." externalDocs: description: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster @@ -43704,6 +44166,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Database Access History for One Cluster by Cluster Name @@ -43773,6 +44237,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Database Access History for One Cluster by Hostname @@ -44118,6 +44584,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Events from One Project @@ -44692,6 +45160,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Atlas Search Metric Types for One Process @@ -44754,6 +45224,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Atlas Search Metrics for One Index in One Namespace @@ -44815,6 +45287,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Atlas Search Index Metrics for One Namespace @@ -44873,6 +45347,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Atlas Search Hardware and Status Metrics @@ -46013,6 +46489,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Managed Slow Operation Threshold Status @@ -46039,6 +46517,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Disable Managed Slow Operation Threshold @@ -46065,6 +46545,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Enable Managed Slow Operation Threshold @@ -48559,6 +49041,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Namespaces for One Host @@ -48652,6 +49136,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Slow Queries @@ -48734,6 +49220,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return All Suggested Indexes @@ -49306,6 +49794,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Return Serverless Auto-Indexing Status @@ -49346,6 +49836,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Set Serverless Auto-Indexing Status @@ -51402,7 +51894,7 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Add Teams to One Project + summary: Add One Team to One Project tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject @@ -51443,6 +51935,44 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + get: + description: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + operationId: getProjectTeam + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/groupId' + - description: Unique 24-hexadecimal digit string that identifies the team for which you want to get. + in: path + name: teamId + required: true + schema: + pattern: ^([a-f0-9]{24})$ + type: string + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2023-01-01+json: + schema: + $ref: '#/components/schemas/TeamRole' + x-xgen-IPA-exception: + xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation + x-xgen-version: "2023-01-01" + description: OK + "400": + $ref: '#/components/responses/badRequest' + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "404": + $ref: '#/components/responses/notFound' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return One Team in One Project + tags: + - Teams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getProjectTeam patch: description: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: @@ -51473,6 +52003,8 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedTeamRoleView' + x-xgen-IPA-exception: + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation x-xgen-version: "2023-01-01" description: OK "400": @@ -53639,7 +54171,7 @@ paths: externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getAtlasResourcePolicies + operationId: listOrgResourcePolicies parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -53673,13 +54205,13 @@ paths: summary: Return All Atlas Resource Policies tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/listOrgResourcePolicies post: description: Create one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: createAtlasResourcePolicy + operationId: createOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -53718,14 +54250,14 @@ paths: summary: Create One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createOrgResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: delete: description: Delete one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: deleteAtlasResourcePolicy + operationId: deleteOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -53759,13 +54291,13 @@ paths: summary: Delete One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteOrgResourcePolicy get: description: Return one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getAtlasResourcePolicy + operationId: getOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -53803,13 +54335,13 @@ paths: summary: Return One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgResourcePolicy patch: description: Update one Atlas Resource Policy for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: updateAtlasResourcePolicy + operationId: updateOrgResourcePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -53858,7 +54390,7 @@ paths: summary: Update One Atlas Resource Policy tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateOrgResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: post: description: Validate one Atlas Resource Policy for an org. @@ -54350,7 +54882,7 @@ paths: x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret /api/atlas/v2/orgs/{orgId}/settings: get: - description: Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + description: Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Member role. operationId: getOrganizationSettings parameters: - $ref: '#/components/parameters/envelope' @@ -54408,6 +54940,8 @@ paths: $ref: '#/components/responses/forbidden' "404": $ref: '#/components/responses/notFound' + "429": + $ref: '#/components/responses/tooManyRequests' "500": $ref: '#/components/responses/internalServerError' summary: Update Settings for One Organization