diff --git a/docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt b/docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt new file mode 100644 index 0000000000..375dd582dd --- /dev/null +++ b/docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt @@ -0,0 +1,115 @@ +.. _atlas-api-accessTracking-getAccessHistoryCluster: + +================================================ +atlas api accessTracking getAccessHistoryCluster +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the access logs of one cluster identified by the cluster's name. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistorycluster. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api accessTracking getAccessHistoryCluster [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 + * - --authResult + - + - false + - flag that indicates whether the response returns the successful authentication attempts only + * - --clusterName + - string + - true + - human-readable label that identifies the cluster + * - --end + - int + - false + - date and time when to stop retrieving database history + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAccessHistoryCluster + * - --ipAddress + - string + - false + - one Internet Protocol address that attempted to authenticate with the database + * - --nLogs + - int + - false + - maximum number of lines from the log to return + * - -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 + * - --start + - int + - false + - date and time when MongoDB Cloud begins retrieving database history + * - --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. + diff --git a/docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt b/docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt new file mode 100644 index 0000000000..c77b952117 --- /dev/null +++ b/docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt @@ -0,0 +1,115 @@ +.. _atlas-api-accessTracking-getAccessHistoryProcess: + +================================================ +atlas api accessTracking getAccessHistoryProcess +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the access logs of one cluster identified by the cluster's hostname. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistoryprocess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api accessTracking getAccessHistoryProcess [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 + * - --authResult + - + - false + - flag that indicates whether the response returns the successful authentication attempts only + * - --end + - int + - false + - date and time when to stop retrieving database history + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAccessHistoryProcess + * - --hostname + - string + - true + - fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download + * - --ipAddress + - string + - false + - one Internet Protocol address that attempted to authenticate with the database + * - --nLogs + - int + - false + - maximum number of lines from the log to return + * - -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 + * - --start + - int + - false + - date and time when MongoDB Cloud begins retrieving database history + * - --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. + diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt deleted file mode 100644 index 008ff6f2ab..0000000000 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-api-accessTracking-listAccessLogsByClusterName: - -==================================================== -atlas api accessTracking listAccessLogsByClusterName -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the access logs of one cluster identified by the cluster's name. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyclustername. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api accessTracking listAccessLogsByClusterName [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 - * - --authResult - - - - false - - Flag that indicates whether the response returns the successful authentication attempts only. - * - --clusterName - - string - - true - - Human-readable label that identifies the cluster. - * - --end - - int - - false - - Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds. - * - --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 listAccessLogsByClusterName - * - --ipAddress - - string - - false - - One Internet Protocol address that attempted to authenticate with the database. - * - --nLogs - - int - - false - - Maximum number of lines from the log to return. - * - -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. - * - --start - - int - - false - - Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds. - * - --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-accessTracking-listAccessLogsByClusterName-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt deleted file mode 100644 index b2e8b01706..0000000000 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-api-accessTracking-listAccessLogsByHostname: - -================================================= -atlas api accessTracking listAccessLogsByHostname -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the access logs of one cluster identified by the cluster's hostname. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyhostname. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api accessTracking listAccessLogsByHostname [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 - * - --authResult - - - - false - - Flag that indicates whether the response returns the successful authentication attempts only. - * - --end - - int - - false - - Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds. - * - --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 listAccessLogsByHostname - * - --hostname - - string - - true - - Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. - * - --ipAddress - - string - - false - - One Internet Protocol address that attempted to authenticate with the database. - * - --nLogs - - int - - false - - Maximum number of lines from the log to return. - * - -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. - * - --start - - int - - false - - Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds. - * - --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-accessTracking-listAccessLogsByHostname-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 2f67464082..6d9bc293c0 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -54,13 +54,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-getAccessHistoryCluster` - Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-getAccessHistoryProcess` - Returns the access logs of one cluster identified by the cluster's hostname. .. toctree:: :titlesonly: - listAccessLogsByClusterName - listAccessLogsByHostname + getAccessHistoryCluster + getAccessHistoryProcess diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfig.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfig.txt new file mode 100644 index 0000000000..4c880b41ce --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfig.txt @@ -0,0 +1,98 @@ +.. _atlas-api-alertConfigurations-createAlertConfig: + +=============================================== +atlas api alertConfigurations createAlertConfig +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one alert configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupalertconfig. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations createAlertConfig [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createAlertConfig + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt deleted file mode 100644 index 846f0d34bd..0000000000 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-alertConfigurations-createAlertConfiguration: - -====================================================== -atlas api alertConfigurations createAlertConfiguration -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one alert configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createalertconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations createAlertConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createAlertConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfig.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfig.txt new file mode 100644 index 0000000000..952d6ac3b9 --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfig.txt @@ -0,0 +1,98 @@ +.. _atlas-api-alertConfigurations-deleteAlertConfig: + +=============================================== +atlas api alertConfigurations deleteAlertConfig +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one alert configuration from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupalertconfig. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations deleteAlertConfig [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 + * - --alertConfigId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert configuration + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteAlertConfig + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt deleted file mode 100644 index 6958629ee1..0000000000 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-alertConfigurations-deleteAlertConfiguration: - -====================================================== -atlas api alertConfigurations deleteAlertConfiguration -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one alert configuration from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletealertconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations deleteAlertConfiguration [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 - * - --alertConfigId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. - * - --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 deleteAlertConfiguration - * - -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. - * - --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-alertConfigurations-deleteAlertConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfig.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfig.txt new file mode 100644 index 0000000000..78381ad9d0 --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfig.txt @@ -0,0 +1,98 @@ +.. _atlas-api-alertConfigurations-getAlertConfig: + +============================================ +atlas api alertConfigurations getAlertConfig +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the specified alert configuration from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertconfig. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations getAlertConfig [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 + * - --alertConfigId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert configuration + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAlertConfig + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfigs.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfigs.txt new file mode 100644 index 0000000000..e378d6fd05 --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfigs.txt @@ -0,0 +1,110 @@ +.. _atlas-api-alertConfigurations-getAlertConfigs: + +============================================= +atlas api alertConfigurations getAlertConfigs +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all alert configurations set for the specified alert. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertalertconfigs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations getAlertConfigs [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 + * - --alertId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAlertConfigs + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt deleted file mode 100644 index 9f865f4679..0000000000 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-alertConfigurations-getAlertConfiguration: - -=================================================== -atlas api alertConfigurations getAlertConfiguration -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the specified alert configuration from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getalertconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations getAlertConfiguration [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 - * - --alertConfigId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. - * - --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 getAlertConfiguration - * - -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. - * - --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-alertConfigurations-getAlertConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigs.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigs.txt new file mode 100644 index 0000000000..b853f393f6 --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigs.txt @@ -0,0 +1,106 @@ +.. _atlas-api-alertConfigurations-listAlertConfigs: + +============================================== +atlas api alertConfigurations listAlertConfigs +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all alert configurations for one project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupalertconfigs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations listAlertConfigs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listAlertConfigs + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt deleted file mode 100644 index 217de5dd48..0000000000 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames: - -====================================================================== -atlas api alertConfigurations listAlertConfigurationMatchersFieldNames -====================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can successfully call this endpoint with any assigned role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurationmatchersfieldnames. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations listAlertConfigurationMatchersFieldNames [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. - * - -h, --help - - - - false - - help for listAlertConfigurationMatchersFieldNames - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt deleted file mode 100644 index 545317bd51..0000000000 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-alertConfigurations-listAlertConfigurations: - -===================================================== -atlas api alertConfigurations listAlertConfigurations -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all alert configurations for one project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurations. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations listAlertConfigurations [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 listAlertConfigurations - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-alertConfigurations-listAlertConfigurations-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt deleted file mode 100644 index 8c56b01dc0..0000000000 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _atlas-api-alertConfigurations-listAlertConfigurationsByAlertId: - -============================================================== -atlas api alertConfigurations listAlertConfigurationsByAlertId -============================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all alert configurations set for the specified alert. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurationsbyalertid. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations listAlertConfigurationsByAlertId [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 - * - --alertId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert. - * - --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 listAlertConfigurationsByAlertId - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-alertConfigurations-listAlertConfigurationsByAlertId-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alertConfigurations-listMatcherFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listMatcherFieldNames.txt new file mode 100644 index 0000000000..6297ad628a --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-listMatcherFieldNames.txt @@ -0,0 +1,87 @@ +.. _atlas-api-alertConfigurations-listMatcherFieldNames: + +=================================================== +atlas api alertConfigurations listMatcherFieldNames +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can successfully call this endpoint with any assigned role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigmatcherfieldnames. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations listMatcherFieldNames [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listMatcherFieldNames + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfig.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfig.txt new file mode 100644 index 0000000000..b8a1ac981d --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfig.txt @@ -0,0 +1,105 @@ +.. _atlas-api-alertConfigurations-toggleAlertConfig: + +=============================================== +atlas api alertConfigurations toggleAlertConfig +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enables or disables the specified alert configuration in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + + +NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupalertconfig. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations toggleAlertConfig [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 + * - --alertConfigId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for toggleAlertConfig + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt deleted file mode 100644 index 28d89dc6d1..0000000000 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-alertConfigurations-toggleAlertConfiguration: - -====================================================== -atlas api alertConfigurations toggleAlertConfiguration -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enables or disables the specified alert configuration in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - - -NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglealertconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations toggleAlertConfiguration [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 - * - --alertConfigId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 toggleAlertConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfig.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfig.txt new file mode 100644 index 0000000000..58f26c88b4 --- /dev/null +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfig.txt @@ -0,0 +1,105 @@ +.. _atlas-api-alertConfigurations-updateAlertConfig: + +=============================================== +atlas api alertConfigurations updateAlertConfig +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one alert configuration in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + + +NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupalertconfig. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alertConfigurations updateAlertConfig [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 + * - --alertConfigId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert configuration + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateAlertConfig + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt deleted file mode 100644 index 77ac0990bd..0000000000 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-alertConfigurations-updateAlertConfiguration: - -====================================================== -atlas api alertConfigurations updateAlertConfiguration -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one alert configuration in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - - -NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatealertconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alertConfigurations updateAlertConfiguration [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 - * - --alertConfigId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAlertConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 1bdc8c7444..91bea88418 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -54,25 +54,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfig` - Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfig` - Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfig` - Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfigs` - Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-listAlertConfigs` - Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listMatcherFieldNames` - Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfig` - Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfig` - Updates one alert configuration in the specified project. .. toctree:: :titlesonly: - createAlertConfiguration - deleteAlertConfiguration - getAlertConfiguration - listAlertConfigurationMatchersFieldNames - listAlertConfigurations - listAlertConfigurationsByAlertId - toggleAlertConfiguration - updateAlertConfiguration + createAlertConfig + deleteAlertConfig + getAlertConfig + getAlertConfigs + listAlertConfigs + listMatcherFieldNames + toggleAlertConfig + updateAlertConfig diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index 88b5b5f967..91b30b1093 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -22,7 +22,7 @@ This alert applies to any component in one project. Acknowledging an alert preve This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acknowledgealert. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acknowledgegroupalert. For more information and examples, see the referenced API documentation linked above. @@ -50,11 +50,11 @@ Options * - --alertId - string - true - - Unique 24-hexadecimal digit string that identifies the alert. + - unique 24-hexadecimal digit string that identifies the alert * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -62,9 +62,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -80,7 +78,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index a9463a0ac9..a86172451f 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -22,7 +22,7 @@ This alert applies to any component in one project. You receive an alert when a This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getalert. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalert. For more information and examples, see the referenced API documentation linked above. @@ -50,17 +50,15 @@ Options * - --alertId - string - true - - Unique 24-hexadecimal digit string that identifies the alert. + - unique 24-hexadecimal digit string that identifies the alert * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -98,8 +96,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-alerts-getAlert-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alerts-getAlertConfigAlerts.txt b/docs/command/atlas-api-alerts-getAlertConfigAlerts.txt new file mode 100644 index 0000000000..7d1ca349a8 --- /dev/null +++ b/docs/command/atlas-api-alerts-getAlertConfigAlerts.txt @@ -0,0 +1,110 @@ +.. _atlas-api-alerts-getAlertConfigAlerts: + +===================================== +atlas api alerts getAlertConfigAlerts +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all open alerts that the specified alert configuration triggers. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertconfigalerts. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api alerts getAlertConfigAlerts [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 + * - --alertConfigId + - string + - true + - unique 24-hexadecimal digit string that identifies the alert configuration + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAlertConfigAlerts + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index dabd1f0f41..e81841b1e7 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -22,7 +22,7 @@ These alerts apply to all components in one project. You receive an alert when a This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalerts. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupalerts. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -64,11 +62,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -80,15 +78,15 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --status - string - false - - Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. + - status of the alerts to return * - --version - string - false @@ -110,8 +108,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-alerts-listAlerts-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt deleted file mode 100644 index b24665d7d6..0000000000 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _atlas-api-alerts-listAlertsByAlertConfigurationId: - -================================================= -atlas api alerts listAlertsByAlertConfigurationId -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all open alerts that the specified alert configuration triggers. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertsbyalertconfigurationid. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api alerts listAlertsByAlertConfigurationId [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 - * - --alertConfigId - - string - - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. - * - --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 listAlertsByAlertConfigurationId - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-alerts-listAlertsByAlertConfigurationId-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index 885e685819..8bdfcf2518 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -56,8 +56,8 @@ Related Commands * :ref:`atlas-api-alerts-acknowledgeAlert` - Confirms receipt of one existing alert. * :ref:`atlas-api-alerts-getAlert` - Returns one alert. +* :ref:`atlas-api-alerts-getAlertConfigAlerts` - Returns all open alerts that the specified alert configuration triggers. * :ref:`atlas-api-alerts-listAlerts` - Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - Returns all open alerts that the specified alert configuration triggers. .. toctree:: @@ -65,6 +65,6 @@ Related Commands acknowledgeAlert getAlert + getAlertConfigAlerts listAlerts - listAlertsByAlertConfigurationId diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt deleted file mode 100644 index 2d5206fea9..0000000000 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-atlasSearch-createAtlasSearchDeployment: - -================================================= -atlas api atlasSearch createAtlasSearchDeployment -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates Search Nodes for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchdeployment. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch createAtlasSearchDeployment [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 - - Label that identifies the cluster to create Search Nodes for. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createAtlasSearchDeployment - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt deleted file mode 100644 index cdaddb7c9c..0000000000 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-atlasSearch-createAtlasSearchIndex: - -============================================ -atlas api atlasSearch createAtlasSearchIndex -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one Atlas Search index on the specified collection. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindex. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch createAtlasSearchIndex [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 - - Name of the cluster that contains the collection on which to create an Atlas Search index. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createAtlasSearchIndex - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt deleted file mode 100644 index 49038d86f1..0000000000 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-atlasSearch-createAtlasSearchIndexDeprecated: - -====================================================== -atlas api atlasSearch createAtlasSearchIndexDeprecated -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one Atlas Search index on the specified collection. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindexdeprecated. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch createAtlasSearchIndexDeprecated [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 - - Name of the cluster that contains the collection on which to create an Atlas Search index. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createAtlasSearchIndexDeprecated - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-atlasSearch-createClusterFtsIndex.txt b/docs/command/atlas-api-atlasSearch-createClusterFtsIndex.txt new file mode 100644 index 0000000000..b0da628811 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-createClusterFtsIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-createClusterFtsIndex: + +=========================================== +atlas api atlasSearch createClusterFtsIndex +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one Atlas Search index on the specified collection. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterftsindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch createClusterFtsIndex [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 + - name of the cluster that contains the collection on which to create an Atlas Search index + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createClusterFtsIndex + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-atlasSearch-createClusterSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createClusterSearchDeployment.txt new file mode 100644 index 0000000000..3e0b480059 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-createClusterSearchDeployment.txt @@ -0,0 +1,105 @@ +.. _atlas-api-atlasSearch-createClusterSearchDeployment: + +=================================================== +atlas api atlasSearch createClusterSearchDeployment +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates Search Nodes for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-creategroupclustersearchdeployment. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch createClusterSearchDeployment [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 + - label that identifies the cluster to create Search Nodes for + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createClusterSearchDeployment + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-atlasSearch-createClusterSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createClusterSearchIndex.txt new file mode 100644 index 0000000000..35591d6369 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-createClusterSearchIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-createClusterSearchIndex: + +============================================== +atlas api atlasSearch createClusterSearchIndex +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one Atlas Search index on the specified collection. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclustersearchindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch createClusterSearchIndex [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 + - name of the cluster that contains the collection on which to create an Atlas Search index + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createClusterSearchIndex + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt deleted file mode 100644 index 54b4e5a48c..0000000000 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-atlasSearch-deleteAtlasSearchDeployment: - -================================================= -atlas api atlasSearch deleteAtlasSearchDeployment -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes the Search Nodes for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchdeployment. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch deleteAtlasSearchDeployment [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 - - Label that identifies the cluster to delete. - * - --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 deleteAtlasSearchDeployment - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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-atlasSearch-deleteAtlasSearchDeployment-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt deleted file mode 100644 index c3e8f1f009..0000000000 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-atlasSearch-deleteAtlasSearchIndex: - -============================================ -atlas api atlasSearch deleteAtlasSearchIndex -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one Atlas Search index that you identified with its unique ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindex. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch deleteAtlasSearchIndex [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 - - Name of the cluster that contains the database and collection with one or more Application Search indexes. - * - --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 deleteAtlasSearchIndex - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-deleteAtlasSearchIndex-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt deleted file mode 100644 index cc5c62a82a..0000000000 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-atlasSearch-deleteAtlasSearchIndexByName: - -================================================== -atlas api atlasSearch deleteAtlasSearchIndexByName -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one Atlas Search index that you identified with its database, collection, and name. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexbyname. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch deleteAtlasSearchIndexByName [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 - - Name of the cluster that contains the database and collection with one or more Application Search indexes. - * - --collectionName - - string - - true - - Name of the collection that contains one or more Atlas Search indexes. - * - --databaseName - - string - - true - - Label that identifies the database that contains the collection with one or more Atlas Search indexes. - * - --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 deleteAtlasSearchIndexByName - * - --indexName - - string - - true - - Name of the Atlas Search index to delete. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-deleteAtlasSearchIndexByName-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt deleted file mode 100644 index 37527bff3a..0000000000 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated: - -====================================================== -atlas api atlasSearch deleteAtlasSearchIndexDeprecated -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one Atlas Search index that you identified with its unique ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexdeprecated. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch deleteAtlasSearchIndexDeprecated [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 - - Name of the cluster that contains the database and collection with one or more Application Search indexes. - * - --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 deleteAtlasSearchIndexDeprecated - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - -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. - * - --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-atlasSearch-deleteAtlasSearchIndexDeprecated-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-deleteClusterFtsIndex.txt b/docs/command/atlas-api-atlasSearch-deleteClusterFtsIndex.txt new file mode 100644 index 0000000000..8401ceb16e --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-deleteClusterFtsIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-deleteClusterFtsIndex: + +=========================================== +atlas api atlasSearch deleteClusterFtsIndex +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one Atlas Search index that you identified with its unique ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterftsindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch deleteClusterFtsIndex [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 + - name of the cluster that contains the database and collection with one or more Application Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterFtsIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Atlas Search index + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-atlasSearch-deleteClusterSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteClusterSearchDeployment.txt new file mode 100644 index 0000000000..ab2a764cd1 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-deleteClusterSearchDeployment.txt @@ -0,0 +1,101 @@ +.. _atlas-api-atlasSearch-deleteClusterSearchDeployment: + +=================================================== +atlas api atlasSearch deleteClusterSearchDeployment +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes the Search Nodes for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-deletegroupclustersearchdeployment. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch deleteClusterSearchDeployment [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 + - label that identifies the cluster to delete + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterSearchDeployment + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-atlasSearch-deleteClusterSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteClusterSearchIndex.txt new file mode 100644 index 0000000000..12e8eb7c73 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-deleteClusterSearchIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-deleteClusterSearchIndex: + +============================================== +atlas api atlasSearch deleteClusterSearchIndex +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one Atlas Search index that you identified with its unique ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersearchindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch deleteClusterSearchIndex [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 + - name of the cluster that contains the database and collection with one or more Application Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterSearchIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Atlas Search index + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-deleteIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteIndexByName.txt new file mode 100644 index 0000000000..bea4cd8dee --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-deleteIndexByName.txt @@ -0,0 +1,107 @@ +.. _atlas-api-atlasSearch-deleteIndexByName: + +======================================= +atlas api atlasSearch deleteIndexByName +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one Atlas Search index that you identified with its database, collection, and name. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersearchindexbyname. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch deleteIndexByName [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 + - name of the cluster that contains the database and collection with one or more Application Search indexes + * - --collectionName + - string + - true + - name of the collection that contains one or more Atlas Search indexes + * - --databaseName + - string + - true + - label that identifies the database that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteIndexByName + * - --indexName + - string + - true + - name of the Atlas Search index to delete + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt deleted file mode 100644 index 73e131763a..0000000000 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-atlasSearch-getAtlasSearchDeployment: - -============================================== -atlas api atlasSearch getAtlasSearchDeployment -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the Search Nodes for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchdeployment. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch getAtlasSearchDeployment [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 - - Label that identifies the cluster to return the Search Nodes for. - * - --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 getAtlasSearchDeployment - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30", "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-atlasSearch-getAtlasSearchDeployment-2025-03-12-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt deleted file mode 100644 index 4f6631c97b..0000000000 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-atlasSearch-getAtlasSearchIndex: - -========================================= -atlas api atlasSearch getAtlasSearchIndex -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one Atlas Search index that you identified with its unique ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindex. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch getAtlasSearchIndex [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --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 getAtlasSearchIndex - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-getAtlasSearchIndex-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt deleted file mode 100644 index 188e013daa..0000000000 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-atlasSearch-getAtlasSearchIndexByName: - -=============================================== -atlas api atlasSearch getAtlasSearchIndexByName -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one Atlas Search index that you identified with its database, collection name, and index name. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexbyname. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch getAtlasSearchIndexByName [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --collectionName - - string - - true - - Name of the collection that contains one or more Atlas Search indexes. - * - --databaseName - - string - - true - - Label that identifies the database that contains the collection with one or more Atlas Search indexes. - * - --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 getAtlasSearchIndexByName - * - --indexName - - string - - true - - Name of the Atlas Search index to return. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-getAtlasSearchIndexByName-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt deleted file mode 100644 index 1c25a400f4..0000000000 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-atlasSearch-getAtlasSearchIndexDeprecated: - -=================================================== -atlas api atlasSearch getAtlasSearchIndexDeprecated -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one Atlas Search index in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexdeprecated. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch getAtlasSearchIndexDeprecated [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --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 getAtlasSearchIndexDeprecated - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. - * - -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. - * - --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-atlasSearch-getAtlasSearchIndexDeprecated-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-getClusterFtsIndex.txt b/docs/command/atlas-api-atlasSearch-getClusterFtsIndex.txt new file mode 100644 index 0000000000..5f3c146189 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-getClusterFtsIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-getClusterFtsIndex: + +======================================== +atlas api atlasSearch getClusterFtsIndex +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one Atlas Search index in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterftsindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch getClusterFtsIndex [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterFtsIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Application Search index + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-atlasSearch-getClusterSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getClusterSearchDeployment.txt new file mode 100644 index 0000000000..517ed62783 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-getClusterSearchDeployment.txt @@ -0,0 +1,93 @@ +.. _atlas-api-atlasSearch-getClusterSearchDeployment: + +================================================ +atlas api atlasSearch getClusterSearchDeployment +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the Search Nodes for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupclustersearchdeployment. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch getClusterSearchDeployment [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 + - label that identifies the cluster to return the Search Nodes for + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterSearchDeployment + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30", "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. + diff --git a/docs/command/atlas-api-atlasSearch-getClusterSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getClusterSearchIndex.txt new file mode 100644 index 0000000000..3b31322e6b --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-getClusterSearchIndex.txt @@ -0,0 +1,99 @@ +.. _atlas-api-atlasSearch-getClusterSearchIndex: + +=========================================== +atlas api atlasSearch getClusterSearchIndex +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one Atlas Search index that you identified with its unique ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersearchindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch getClusterSearchIndex [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterSearchIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Application Search index + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-getIndexByName.txt b/docs/command/atlas-api-atlasSearch-getIndexByName.txt new file mode 100644 index 0000000000..80091f9256 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-getIndexByName.txt @@ -0,0 +1,107 @@ +.. _atlas-api-atlasSearch-getIndexByName: + +==================================== +atlas api atlasSearch getIndexByName +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one Atlas Search index that you identified with its database, collection name, and index name. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersearchindexbyname. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch getIndexByName [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --collectionName + - string + - true + - name of the collection that contains one or more Atlas Search indexes + * - --databaseName + - string + - true + - label that identifies the database that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getIndexByName + * - --indexName + - string + - true + - name of the Atlas Search index to return + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt deleted file mode 100644 index ce41cdfd4d..0000000000 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-atlasSearch-listAtlasSearchIndexes: - -============================================ -atlas api atlasSearch listAtlasSearchIndexes -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Atlas Search indexes on the specified collection. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexes. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch listAtlasSearchIndexes [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --collectionName - - string - - true - - Name of the collection that contains one or more Atlas Search indexes. - * - --databaseName - - string - - true - - Label that identifies the database that contains the collection with one or more Atlas Search indexes. - * - --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 listAtlasSearchIndexes - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-listAtlasSearchIndexes-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt deleted file mode 100644 index 63068e8aaf..0000000000 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-atlasSearch-listAtlasSearchIndexesCluster: - -=================================================== -atlas api atlasSearch listAtlasSearchIndexesCluster -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Atlas Search indexes on the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexescluster. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch listAtlasSearchIndexesCluster [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --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 listAtlasSearchIndexesCluster - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-atlasSearch-listAtlasSearchIndexesCluster-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt deleted file mode 100644 index 5fd36ed7a0..0000000000 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated: - -====================================================== -atlas api atlasSearch listAtlasSearchIndexesDeprecated -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Atlas Search indexes on the specified collection. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexesdeprecated. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch listAtlasSearchIndexesDeprecated [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 - - Name of the cluster that contains the collection with one or more Atlas Search indexes. - * - --collectionName - - string - - true - - Name of the collection that contains one or more Atlas Search indexes. - * - --databaseName - - string - - true - - Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. - * - --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 listAtlasSearchIndexesDeprecated - * - -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. - * - --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-atlasSearch-listAtlasSearchIndexesDeprecated-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-atlasSearch-listClusterFtsIndex.txt b/docs/command/atlas-api-atlasSearch-listClusterFtsIndex.txt new file mode 100644 index 0000000000..441668a6e0 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-listClusterFtsIndex.txt @@ -0,0 +1,103 @@ +.. _atlas-api-atlasSearch-listClusterFtsIndex: + +========================================= +atlas api atlasSearch listClusterFtsIndex +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Search indexes on the specified collection. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterftsindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch listClusterFtsIndex [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --collectionName + - string + - true + - name of the collection that contains one or more Atlas Search indexes + * - --databaseName + - string + - true + - human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterFtsIndex + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-atlasSearch-listClusterSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listClusterSearchIndexes.txt new file mode 100644 index 0000000000..e8277b759a --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-listClusterSearchIndexes.txt @@ -0,0 +1,95 @@ +.. _atlas-api-atlasSearch-listClusterSearchIndexes: + +============================================== +atlas api atlasSearch listClusterSearchIndexes +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Search indexes on the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersearchindexes. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch listClusterSearchIndexes [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterSearchIndexes + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-listSearchIndex.txt b/docs/command/atlas-api-atlasSearch-listSearchIndex.txt new file mode 100644 index 0000000000..909417701a --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-listSearchIndex.txt @@ -0,0 +1,103 @@ +.. _atlas-api-atlasSearch-listSearchIndex: + +===================================== +atlas api atlasSearch listSearchIndex +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Search indexes on the specified collection. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersearchindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch listSearchIndex [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 + - name of the cluster that contains the collection with one or more Atlas Search indexes + * - --collectionName + - string + - true + - name of the collection that contains one or more Atlas Search indexes + * - --databaseName + - string + - true + - label that identifies the database that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listSearchIndex + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt deleted file mode 100644 index 57432cf1b3..0000000000 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-atlasSearch-updateAtlasSearchDeployment: - -================================================= -atlas api atlasSearch updateAtlasSearchDeployment -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the Search Nodes for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchdeployment. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch updateAtlasSearchDeployment [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 - - Label that identifies the cluster to update the Search Nodes for. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAtlasSearchDeployment - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt deleted file mode 100644 index b685778861..0000000000 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-atlasSearch-updateAtlasSearchIndex: - -============================================ -atlas api atlasSearch updateAtlasSearchIndex -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one Atlas Search index that you identified with its unique ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindex. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch updateAtlasSearchIndex [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 - - Name of the cluster that contains the collection whose Atlas Search index you want to update. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAtlasSearchIndex - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt deleted file mode 100644 index 76e4fe01bd..0000000000 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-atlasSearch-updateAtlasSearchIndexByName: - -================================================== -atlas api atlasSearch updateAtlasSearchIndexByName -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one Atlas Search index that you identified with its database, collection name, and index name. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexbyname. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch updateAtlasSearchIndexByName [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 - - Name of the cluster that contains the collection whose Atlas Search index you want to update. - * - --collectionName - - string - - true - - Name of the collection that contains one or more Atlas Search indexes. - * - --databaseName - - string - - true - - Label that identifies the database that contains the collection with one or more Atlas Search indexes. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAtlasSearchIndexByName - * - --indexName - - string - - true - - Name of the Atlas Search index to update. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt deleted file mode 100644 index af233b034c..0000000000 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated: - -====================================================== -atlas api atlasSearch updateAtlasSearchIndexDeprecated -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one Atlas Search index that you identified with its unique ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexdeprecated. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api atlasSearch updateAtlasSearchIndexDeprecated [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 - - Name of the cluster that contains the collection whose Atlas Search index to update. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAtlasSearchIndexDeprecated - * - --indexId - - string - - true - - Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-atlasSearch-updateClusterFtsIndex.txt b/docs/command/atlas-api-atlasSearch-updateClusterFtsIndex.txt new file mode 100644 index 0000000000..7848888375 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-updateClusterFtsIndex.txt @@ -0,0 +1,103 @@ +.. _atlas-api-atlasSearch-updateClusterFtsIndex: + +=========================================== +atlas api atlasSearch updateClusterFtsIndex +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one Atlas Search index that you identified with its unique ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterftsindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch updateClusterFtsIndex [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 + - name of the cluster that contains the collection whose Atlas Search index to update + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateClusterFtsIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Atlas Search index + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-atlasSearch-updateClusterSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateClusterSearchDeployment.txt new file mode 100644 index 0000000000..d1419282af --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-updateClusterSearchDeployment.txt @@ -0,0 +1,105 @@ +.. _atlas-api-atlasSearch-updateClusterSearchDeployment: + +=================================================== +atlas api atlasSearch updateClusterSearchDeployment +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the Search Nodes for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-updategroupclustersearchdeployment. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch updateClusterSearchDeployment [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 + - label that identifies the cluster to update the Search Nodes for + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateClusterSearchDeployment + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-atlasSearch-updateClusterSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateClusterSearchIndex.txt new file mode 100644 index 0000000000..188785152c --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-updateClusterSearchIndex.txt @@ -0,0 +1,103 @@ +.. _atlas-api-atlasSearch-updateClusterSearchIndex: + +============================================== +atlas api atlasSearch updateClusterSearchIndex +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one Atlas Search index that you identified with its unique ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersearchindex. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch updateClusterSearchIndex [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 + - name of the cluster that contains the collection whose Atlas Search index you want to update + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateClusterSearchIndex + * - --indexId + - string + - true + - unique 24-hexadecimal digit string that identifies the Atlas Search index + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch-updateIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateIndexByName.txt new file mode 100644 index 0000000000..79e9b1cf89 --- /dev/null +++ b/docs/command/atlas-api-atlasSearch-updateIndexByName.txt @@ -0,0 +1,111 @@ +.. _atlas-api-atlasSearch-updateIndexByName: + +======================================= +atlas api atlasSearch updateIndexByName +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one Atlas Search index that you identified with its database, collection name, and index name. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersearchindexbyname. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api atlasSearch updateIndexByName [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 + - name of the cluster that contains the collection whose Atlas Search index you want to update + * - --collectionName + - string + - true + - name of the collection that contains one or more Atlas Search indexes + * - --databaseName + - string + - true + - label that identifies the database that contains the collection with one or more Atlas Search indexes + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateIndexByName + * - --indexName + - string + - true + - name of the Atlas Search index to update + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index e953495f54..8070734139 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -54,45 +54,45 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - Returns one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createClusterFtsIndex` - Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createClusterSearchDeployment` - Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createClusterSearchIndex` - Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteClusterFtsIndex` - Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteClusterSearchDeployment` - Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteClusterSearchIndex` - Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteIndexByName` - Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-getClusterFtsIndex` - Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getClusterSearchDeployment` - Returns the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getClusterSearchIndex` - Returns one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getIndexByName` - Returns one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-listClusterFtsIndex` - Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listClusterSearchIndexes` - Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listSearchIndex` - Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateClusterFtsIndex` - Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateClusterSearchDeployment` - Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateClusterSearchIndex` - Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateIndexByName` - Updates one Atlas Search index that you identified with its database, collection name, and index name. .. toctree:: :titlesonly: - createAtlasSearchDeployment - createAtlasSearchIndex - createAtlasSearchIndexDeprecated - deleteAtlasSearchDeployment - deleteAtlasSearchIndex - deleteAtlasSearchIndexByName - deleteAtlasSearchIndexDeprecated - getAtlasSearchDeployment - getAtlasSearchIndex - getAtlasSearchIndexByName - getAtlasSearchIndexDeprecated - listAtlasSearchIndexes - listAtlasSearchIndexesCluster - listAtlasSearchIndexesDeprecated - updateAtlasSearchDeployment - updateAtlasSearchIndex - updateAtlasSearchIndexByName - updateAtlasSearchIndexDeprecated + createClusterFtsIndex + createClusterSearchDeployment + createClusterSearchIndex + deleteClusterFtsIndex + deleteClusterSearchDeployment + deleteClusterSearchIndex + deleteIndexByName + getClusterFtsIndex + getClusterSearchDeployment + getClusterSearchIndex + getIndexByName + listClusterFtsIndex + listClusterSearchIndexes + listSearchIndex + updateClusterFtsIndex + updateClusterSearchDeployment + updateClusterSearchIndex + updateIndexByName diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt deleted file mode 100644 index 7d9dbbb1b0..0000000000 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-auditing-getAuditingConfiguration: - -=========================================== -atlas api auditing getAuditingConfiguration -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the auditing configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getauditingconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api auditing getAuditingConfiguration [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 getAuditingConfiguration - * - -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. - * - --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-auditing-getAuditingConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-auditing-getGroupAuditLog.txt b/docs/command/atlas-api-auditing-getGroupAuditLog.txt new file mode 100644 index 0000000000..2a2d789eac --- /dev/null +++ b/docs/command/atlas-api-auditing-getGroupAuditLog.txt @@ -0,0 +1,98 @@ +.. _atlas-api-auditing-getGroupAuditLog: + +=================================== +atlas api auditing getGroupAuditLog +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the auditing configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupauditlog. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api auditing getGroupAuditLog [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 getGroupAuditLog + * - -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. + * - --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-auditing-getGroupAuditLog-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-auditing-updateAuditLog.txt b/docs/command/atlas-api-auditing-updateAuditLog.txt new file mode 100644 index 0000000000..730f64e74d --- /dev/null +++ b/docs/command/atlas-api-auditing-updateAuditLog.txt @@ -0,0 +1,95 @@ +.. _atlas-api-auditing-updateAuditLog: + +================================= +atlas api auditing updateAuditLog +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the auditing configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupauditlog. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api auditing updateAuditLog [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateAuditLog + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt deleted file mode 100644 index 200f66ff9d..0000000000 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-auditing-updateAuditingConfiguration: - -============================================== -atlas api auditing updateAuditingConfiguration -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the auditing configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateauditingconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api auditing updateAuditingConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateAuditingConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index afcd5a6880..7188aab49f 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -54,13 +54,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getGroupAuditLog` - Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditLog` - Updates the auditing configuration for the specified project. .. toctree:: :titlesonly: - getAuditingConfiguration - updateAuditingConfiguration + getGroupAuditLog + updateAuditLog diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index 05fcb027aa..e92b864028 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getawscustomdns. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupawscustomdns. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,7 +67,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -91,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-awsClustersDns-getAwsCustomDns-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 89ed58e71a..22c81e5da5 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleawscustomdns. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupawscustomdns. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 47e815646f..548205a644 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cancelbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cancelgroupclusterbackuprestorejob. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --restoreJobId - string - true - - Unique 24-hexadecimal digit string that identifies the restore job to remove. + - unique 24-hexadecimal digit string that identifies the restore job to remove * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-cancelBackupRestoreJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-createBackupExport.txt b/docs/command/atlas-api-cloudBackups-createBackupExport.txt new file mode 100644 index 0000000000..8924895ea0 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-createBackupExport.txt @@ -0,0 +1,103 @@ +.. _atlas-api-cloudBackups-createBackupExport: + +========================================= +atlas api cloudBackups createBackupExport +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackupexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups createBackupExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createBackupExport + * - -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) + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt deleted file mode 100644 index 4df0b40a31..0000000000 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-cloudBackups-createBackupExportJob: - -============================================ -atlas api cloudBackups createBackupExportJob -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createbackupexportjob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups createBackupExportJob [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createBackupExportJob - * - -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) - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index d262b5ee7e..cfe9cc68fc 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -22,7 +22,7 @@ Atlas takes on-demand snapshots immediately and scheduled snapshots at regular i To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackuprestorejob. For more information and examples, see the referenced API documentation linked above. @@ -50,11 +50,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -62,9 +62,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -80,7 +78,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 1b402c778c..7fe31a2e69 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createexportbucket. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupbackupexportbucket. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,60 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. tabs:: - - .. tab:: Example - :tabid: 2023-01-01_aws - - AWS - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws.sh - :language: shell - .. tab:: Example 1 - :tabid: 2024-05-30_aws - - AWS - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws.sh - :language: shell - .. tab:: Example 2 - :tabid: 2024-05-30_azure - - Azure - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure.sh - :language: shell - .. tab:: Example 3 - :tabid: 2024-05-30_gcp - - GCP - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt deleted file mode 100644 index 4d9c86ebe9..0000000000 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-cloudBackups-createServerlessBackupRestoreJob: - -======================================================= -atlas api cloudBackups createServerlessBackupRestoreJob -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restores one snapshot of one serverless instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups createServerlessBackupRestoreJob [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 serverless instance whose snapshot you want to restore. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createServerlessBackupRestoreJob - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-cloudBackups-createServerlessRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessRestoreJob.txt new file mode 100644 index 0000000000..067cada8ef --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-createServerlessRestoreJob.txt @@ -0,0 +1,102 @@ +.. _atlas-api-cloudBackups-createServerlessRestoreJob: + +================================================= +atlas api cloudBackups createServerlessRestoreJob +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Restores one snapshot of one serverless instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserverlessbackuprestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups createServerlessRestoreJob [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 serverless instance whose snapshot you want to restore + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createServerlessRestoreJob + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt deleted file mode 100644 index 11be17bfd8..0000000000 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-cloudBackups-deleteAllBackupSchedules: - -=============================================== -atlas api cloudBackups deleteAllBackupSchedules -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes all cloud backup schedules for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallbackupschedules. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups deleteAllBackupSchedules [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 deleteAllBackupSchedules - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-cloudBackups-deleteAllBackupSchedules-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-deleteBackupShardedCluster.txt b/docs/command/atlas-api-cloudBackups-deleteBackupShardedCluster.txt new file mode 100644 index 0000000000..8cdaf20f06 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-deleteBackupShardedCluster.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudBackups-deleteBackupShardedCluster: + +================================================= +atlas api cloudBackups deleteBackupShardedCluster +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one snapshot of one sharded cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupsnapshotshardedcluster. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups deleteBackupShardedCluster [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteBackupShardedCluster + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-deleteClusterBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-deleteClusterBackupSchedule.txt new file mode 100644 index 0000000000..bbc969546f --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-deleteClusterBackupSchedule.txt @@ -0,0 +1,91 @@ +.. _atlas-api-cloudBackups-deleteClusterBackupSchedule: + +================================================== +atlas api cloudBackups deleteClusterBackupSchedule +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes all cloud backup schedules for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupschedule. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups deleteClusterBackupSchedule [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterBackupSchedule + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-cloudBackups-deleteClusterBackupSnapshot.txt b/docs/command/atlas-api-cloudBackups-deleteClusterBackupSnapshot.txt new file mode 100644 index 0000000000..2e6d961262 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-deleteClusterBackupSnapshot.txt @@ -0,0 +1,107 @@ +.. _atlas-api-cloudBackups-deleteClusterBackupSnapshot: + +================================================== +atlas api cloudBackups deleteClusterBackupSnapshot +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified snapshot. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups deleteClusterBackupSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterBackupSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 0915de7a6f..c6457a39c2 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteexportbucket. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupbackupexportbucket. For more information and examples, see the referenced API documentation linked above. @@ -45,19 +45,17 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --exportBucketId - string - true - - Unique 24-hexadecimal character string that identifies the Export Bucket. + - unique 24-hexadecimal character string that identifies the Export Bucket * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -91,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-deleteExportBucket-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt deleted file mode 100644 index 8e798ff6f4..0000000000 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-cloudBackups-deleteReplicaSetBackup: - -============================================= -atlas api cloudBackups deleteReplicaSetBackup -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified snapshot. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletereplicasetbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups deleteReplicaSetBackup [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 deleteReplicaSetBackup - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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-cloudBackups-deleteReplicaSetBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt deleted file mode 100644 index e10e7ac88c..0000000000 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-cloudBackups-deleteShardedClusterBackup: - -================================================= -atlas api cloudBackups deleteShardedClusterBackup -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one snapshot of one sharded cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteshardedclusterbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups deleteShardedClusterBackup [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 deleteShardedClusterBackup - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-cloudBackups-deleteShardedClusterBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-disableCompliancePolicy.txt b/docs/command/atlas-api-cloudBackups-disableCompliancePolicy.txt new file mode 100644 index 0000000000..ca0e57eee8 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-disableCompliancePolicy.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudBackups-disableCompliancePolicy: + +============================================== +atlas api cloudBackups disableCompliancePolicy +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disables the Backup Compliance Policy settings with the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupbackupcompliancepolicy. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups disableCompliancePolicy [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for disableCompliancePolicy + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt deleted file mode 100644 index a38ae87390..0000000000 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-cloudBackups-disableDataProtectionSettings: - -==================================================== -atlas api cloudBackups disableDataProtectionSettings -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disables the Backup Compliance Policy settings with the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disabledataprotectionsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups disableDataProtectionSettings [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 disableDataProtectionSettings - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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-cloudBackups-disableDataProtectionSettings-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getBackupExport.txt b/docs/command/atlas-api-cloudBackups-getBackupExport.txt new file mode 100644 index 0000000000..da41e6f9ad --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getBackupExport.txt @@ -0,0 +1,95 @@ +.. _atlas-api-cloudBackups-getBackupExport: + +====================================== +atlas api cloudBackups getBackupExport +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getBackupExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --exportId + - string + - true + - unique 24-hexadecimal character string that identifies the Export Job + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getBackupExport + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt deleted file mode 100644 index 1a627ef0ab..0000000000 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-cloudBackups-getBackupExportJob: - -========================================= -atlas api cloudBackups getBackupExportJob -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupexportjob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getBackupExportJob [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. - * - --exportId - - string - - true - - Unique 24-hexadecimal character string that identifies the Export Job. - * - --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 getBackupExportJob - * - -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) - * - --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-cloudBackups-getBackupExportJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index f523895171..a9f3a58c0d 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuprestorejob. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster with the restore jobs you want to return. + - human-readable label that identifies the cluster with the restore jobs you want to return * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --restoreJobId - string - true - - Unique 24-hexadecimal digit string that identifies the restore job to return. + - unique 24-hexadecimal digit string that identifies the restore job to return * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-getBackupRestoreJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 34dc332146..0e590cfe5f 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupschedule. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-getBackupSchedule-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getBackupShardedCluster.txt b/docs/command/atlas-api-cloudBackups-getBackupShardedCluster.txt new file mode 100644 index 0000000000..0913294c41 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getBackupShardedCluster.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudBackups-getBackupShardedCluster: + +============================================== +atlas api cloudBackups getBackupShardedCluster +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one snapshot of one sharded cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupsnapshotshardedcluster. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getBackupShardedCluster [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getBackupShardedCluster + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-getClusterBackupSnapshot.txt b/docs/command/atlas-api-cloudBackups-getClusterBackupSnapshot.txt new file mode 100644 index 0000000000..4c76452e30 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getClusterBackupSnapshot.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudBackups-getClusterBackupSnapshot: + +=============================================== +atlas api cloudBackups getClusterBackupSnapshot +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one snapshot from the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getClusterBackupSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterBackupSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-getCompliancePolicy.txt b/docs/command/atlas-api-cloudBackups-getCompliancePolicy.txt new file mode 100644 index 0000000000..daa0337a0c --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getCompliancePolicy.txt @@ -0,0 +1,91 @@ +.. _atlas-api-cloudBackups-getCompliancePolicy: + +========================================== +atlas api cloudBackups getCompliancePolicy +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the Backup Compliance Policy settings with the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbackupcompliancepolicy. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getCompliancePolicy [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getCompliancePolicy + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-10-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-10-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. + diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt deleted file mode 100644 index 93dd183357..0000000000 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-cloudBackups-getDataProtectionSettings: - -================================================ -atlas api cloudBackups getDataProtectionSettings -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the Backup Compliance Policy settings with the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdataprotectionsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getDataProtectionSettings [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 getDataProtectionSettings - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-10-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-10-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-cloudBackups-getDataProtectionSettings-2023-10-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 87aa0bf997..666640d190 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getexportbucket. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbackupexportbucket. For more information and examples, see the referenced API documentation linked above. @@ -45,19 +45,17 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --exportBucketId - string - true - - Unique 24-hexadecimal character string that identifies the Export Bucket. + - unique 24-hexadecimal character string that identifies the Export Bucket * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -91,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-getExportBucket-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt deleted file mode 100644 index 969d18603c..0000000000 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-cloudBackups-getReplicaSetBackup: - -========================================== -atlas api cloudBackups getReplicaSetBackup -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one snapshot from the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getreplicasetbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getReplicaSetBackup [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 getReplicaSetBackup - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-cloudBackups-getReplicaSetBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt deleted file mode 100644 index aab8349fa9..0000000000 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-cloudBackups-getServerlessBackup: - -========================================== -atlas api cloudBackups getServerlessBackup -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one snapshot of one serverless instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This endpoint can also be used on Flex clusters that were created with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getServerlessBackup [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 serverless instance. - * - --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 getServerlessBackup - * - -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) - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-cloudBackups-getServerlessBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt deleted file mode 100644 index e784107b52..0000000000 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-cloudBackups-getServerlessBackupRestoreJob: - -==================================================== -atlas api cloudBackups getServerlessBackupRestoreJob -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one restore job for one serverless instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getServerlessBackupRestoreJob [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 serverless instance. - * - --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 getServerlessBackupRestoreJob - * - -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. - * - --restoreJobId - - string - - true - - Unique 24-hexadecimal digit string that identifies the restore job to return. - * - --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-cloudBackups-getServerlessBackupRestoreJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupSnapshot.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupSnapshot.txt new file mode 100644 index 0000000000..4cb92afbb7 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupSnapshot.txt @@ -0,0 +1,98 @@ +.. _atlas-api-cloudBackups-getServerlessBackupSnapshot: + +================================================== +atlas api cloudBackups getServerlessBackupSnapshot +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one snapshot of one serverless instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This endpoint can also be used on Flex clusters that were created with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessbackupsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getServerlessBackupSnapshot [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 serverless instance + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getServerlessBackupSnapshot + * - -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) + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-getServerlessRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessRestoreJob.txt new file mode 100644 index 0000000000..1d4274b134 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-getServerlessRestoreJob.txt @@ -0,0 +1,102 @@ +.. _atlas-api-cloudBackups-getServerlessRestoreJob: + +============================================== +atlas api cloudBackups getServerlessRestoreJob +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one restore job for one serverless instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessbackuprestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups getServerlessRestoreJob [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 serverless instance + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getServerlessRestoreJob + * - -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 + * - --restoreJobId + - string + - true + - unique 24-hexadecimal digit string that identifies the restore job to return + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt deleted file mode 100644 index 078507953d..0000000000 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-cloudBackups-getShardedClusterBackup: - -============================================== -atlas api cloudBackups getShardedClusterBackup -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one snapshot of one sharded cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getshardedclusterbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups getShardedClusterBackup [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 getShardedClusterBackup - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-cloudBackups-getShardedClusterBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt deleted file mode 100644 index 85ddbf6540..0000000000 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-cloudBackups-listBackupExportJobs: - -=========================================== -atlas api cloudBackups listBackupExportJobs -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackupexportjobs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups listBackupExportJobs [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 listBackupExportJobs - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-cloudBackups-listBackupExportJobs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listBackupExports.txt b/docs/command/atlas-api-cloudBackups-listBackupExports.txt new file mode 100644 index 0000000000..79bbd0e22a --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-listBackupExports.txt @@ -0,0 +1,107 @@ +.. _atlas-api-cloudBackups-listBackupExports: + +======================================== +atlas api cloudBackups listBackupExports +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupexports. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups listBackupExports [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listBackupExports + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 67748dee4b..5dbf1e47d5 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuprestorejobs. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster with the restore jobs you want to return. + - human-readable label that identifies the cluster with the restore jobs you want to return * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -65,11 +63,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -81,11 +79,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -107,8 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-listBackupRestoreJobs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listBackupShardedClusters.txt b/docs/command/atlas-api-cloudBackups-listBackupShardedClusters.txt new file mode 100644 index 0000000000..8d687730db --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-listBackupShardedClusters.txt @@ -0,0 +1,95 @@ +.. _atlas-api-cloudBackups-listBackupShardedClusters: + +================================================ +atlas api cloudBackups listBackupShardedClusters +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all snapshots of one sharded cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupsnapshotshardedclusters. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups listBackupShardedClusters [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listBackupShardedClusters + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-listBackupSnapshots.txt b/docs/command/atlas-api-cloudBackups-listBackupSnapshots.txt new file mode 100644 index 0000000000..596899a75b --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-listBackupSnapshots.txt @@ -0,0 +1,107 @@ +.. _atlas-api-cloudBackups-listBackupSnapshots: + +========================================== +atlas api cloudBackups listBackupSnapshots +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all snapshots of one cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupsnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups listBackupSnapshots [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listBackupSnapshots + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index a31c100e5a..166e116c1d 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listexportbuckets. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupbackupexportbuckets. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,11 +59,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -77,11 +75,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudBackups-listExportBuckets-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt deleted file mode 100644 index 41925e8c0f..0000000000 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-cloudBackups-listReplicaSetBackups: - -============================================ -atlas api cloudBackups listReplicaSetBackups -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all snapshots of one cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listreplicasetbackups. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups listReplicaSetBackups [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 listReplicaSetBackups - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-cloudBackups-listReplicaSetBackups-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt deleted file mode 100644 index be1d43005e..0000000000 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _atlas-api-cloudBackups-listServerlessBackupRestoreJobs: - -====================================================== -atlas api cloudBackups listServerlessBackupRestoreJobs -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all restore jobs for one serverless instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessbackuprestorejobs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups listServerlessBackupRestoreJobs [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 serverless instance. - * - --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 listServerlessBackupRestoreJobs - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-cloudBackups-listServerlessBackupRestoreJobs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupSnapshots.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupSnapshots.txt new file mode 100644 index 0000000000..35c2fce91f --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupSnapshots.txt @@ -0,0 +1,110 @@ +.. _atlas-api-cloudBackups-listServerlessBackupSnapshots: + +==================================================== +atlas api cloudBackups listServerlessBackupSnapshots +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all snapshots of one serverless instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessbackupsnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups listServerlessBackupSnapshots [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 serverless instance + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listServerlessBackupSnapshots + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt deleted file mode 100644 index 1da6c51928..0000000000 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _atlas-api-cloudBackups-listServerlessBackups: - -============================================ -atlas api cloudBackups listServerlessBackups -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all snapshots of one serverless instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessbackups. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups listServerlessBackups [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 serverless instance. - * - --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 listServerlessBackups - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-cloudBackups-listServerlessBackups-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-listServerlessRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessRestoreJobs.txt new file mode 100644 index 0000000000..8bcf2ebb49 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-listServerlessRestoreJobs.txt @@ -0,0 +1,110 @@ +.. _atlas-api-cloudBackups-listServerlessRestoreJobs: + +================================================ +atlas api cloudBackups listServerlessRestoreJobs +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all restore jobs for one serverless instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessbackuprestorejobs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups listServerlessRestoreJobs [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 serverless instance + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listServerlessRestoreJobs + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt deleted file mode 100644 index 29d5c13c6a..0000000000 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-cloudBackups-listShardedClusterBackups: - -================================================ -atlas api cloudBackups listShardedClusterBackups -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all snapshots of one sharded cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listshardedclusterbackups. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups listShardedClusterBackups [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 listShardedClusterBackups - * - -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. - * - --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-cloudBackups-listShardedClusterBackups-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt deleted file mode 100644 index 0a9559e5c8..0000000000 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-api-cloudBackups-takeSnapshot: - -=================================== -atlas api cloudBackups takeSnapshot -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Takes one on-demand snapshot for the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. - - -To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-takesnapshot. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups takeSnapshot [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 takeSnapshot - * - -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. - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshots.txt b/docs/command/atlas-api-cloudBackups-takeSnapshots.txt new file mode 100644 index 0000000000..820c20e483 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-takeSnapshots.txt @@ -0,0 +1,110 @@ +.. _atlas-api-cloudBackups-takeSnapshots: + +==================================== +atlas api cloudBackups takeSnapshots +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Takes one on-demand snapshot for the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-takegroupclusterbackupsnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups takeSnapshots [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for takeSnapshots + * - -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 + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index abe39cee03..cda0b9c2db 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatebackupschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterbackupschedule. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSnapshot.txt b/docs/command/atlas-api-cloudBackups-updateBackupSnapshot.txt new file mode 100644 index 0000000000..1e9a069b66 --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-updateBackupSnapshot.txt @@ -0,0 +1,111 @@ +.. _atlas-api-cloudBackups-updateBackupSnapshot: + +=========================================== +atlas api cloudBackups updateBackupSnapshot +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The requesting API Key must have the Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterbackupsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups updateBackupSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateBackupSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-updateCompliancePolicy.txt b/docs/command/atlas-api-cloudBackups-updateCompliancePolicy.txt new file mode 100644 index 0000000000..921c378dda --- /dev/null +++ b/docs/command/atlas-api-cloudBackups-updateCompliancePolicy.txt @@ -0,0 +1,107 @@ +.. _atlas-api-cloudBackups-updateCompliancePolicy: + +============================================= +atlas api cloudBackups updateCompliancePolicy +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the Backup Compliance Policy settings for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupbackupcompliancepolicy. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudBackups updateCompliancePolicy [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateCompliancePolicy + * - -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) + * - --overwriteBackupPolicies + - + - false + - flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-10-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-10-01". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt deleted file mode 100644 index 6b5e7cad50..0000000000 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-cloudBackups-updateDataProtectionSettings: - -=================================================== -atlas api cloudBackups updateDataProtectionSettings -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the Backup Compliance Policy settings for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedataprotectionsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups updateDataProtectionSettings [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateDataProtectionSettings - * - -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) - * - --overwriteBackupPolicies - - - - false - - Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-10-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-10-01". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt deleted file mode 100644 index 3ceebec77d..0000000000 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-cloudBackups-updateSnapshotRetention: - -============================================== -atlas api cloudBackups updateSnapshotRetention -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The requesting API Key must have the Project Backup Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatesnapshotretention. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudBackups updateSnapshotRetention [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateSnapshotRetention - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index a27eaa2b75..a6dd89b9d9 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -55,68 +55,68 @@ Related Commands ---------------- * :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupExport` - Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. * :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - Restores one snapshot of one cluster from the specified project. * :ref:`atlas-api-cloudBackups-createExportBucket` - Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-createServerlessRestoreJob` - Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteBackupShardedCluster` - Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-deleteClusterBackupSchedule` - Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteClusterBackupSnapshot` - Removes the specified snapshot. * :ref:`atlas-api-cloudBackups-deleteExportBucket` - Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-disableCompliancePolicy` - Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExport` - Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. * :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - Returns one cloud backup restore job for one cluster from the specified project. * :ref:`atlas-api-cloudBackups-getBackupSchedule` - Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupShardedCluster` - Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getClusterBackupSnapshot` - Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getCompliancePolicy` - Returns the Backup Compliance Policy settings with the specified project. * :ref:`atlas-api-cloudBackups-getExportBucket` - Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackupSnapshot` - Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessRestoreJob` - Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExports` - Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. * :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupShardedClusters` - Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupSnapshots` - Returns all snapshots of one cluster from the specified project. * :ref:`atlas-api-cloudBackups-listExportBuckets` - Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-listServerlessBackupSnapshots` - Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessRestoreJobs` - Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshots` - Takes one on-demand snapshot for the specified cluster. * :ref:`atlas-api-cloudBackups-updateBackupSchedule` - Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-updateBackupSnapshot` - Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-updateCompliancePolicy` - Updates the Backup Compliance Policy settings for the specified project. .. toctree:: :titlesonly: cancelBackupRestoreJob - createBackupExportJob + createBackupExport createBackupRestoreJob createExportBucket - createServerlessBackupRestoreJob - deleteAllBackupSchedules + createServerlessRestoreJob + deleteBackupShardedCluster + deleteClusterBackupSchedule + deleteClusterBackupSnapshot deleteExportBucket - deleteReplicaSetBackup - deleteShardedClusterBackup - disableDataProtectionSettings - getBackupExportJob + disableCompliancePolicy + getBackupExport getBackupRestoreJob getBackupSchedule - getDataProtectionSettings + getBackupShardedCluster + getClusterBackupSnapshot + getCompliancePolicy getExportBucket - getReplicaSetBackup - getServerlessBackup - getServerlessBackupRestoreJob - getShardedClusterBackup - listBackupExportJobs + getServerlessBackupSnapshot + getServerlessRestoreJob + listBackupExports listBackupRestoreJobs + listBackupShardedClusters + listBackupSnapshots listExportBuckets - listReplicaSetBackups - listServerlessBackupRestoreJobs - listServerlessBackups - listShardedClusterBackups - takeSnapshot + listServerlessBackupSnapshots + listServerlessRestoreJobs + takeSnapshots updateBackupSchedule - updateDataProtectionSettings - updateSnapshotRetention + updateBackupSnapshot + updateCompliancePolicy diff --git a/docs/command/atlas-api-cloudMigrationService-createGroupLiveMigration.txt b/docs/command/atlas-api-cloudMigrationService-createGroupLiveMigration.txt new file mode 100644 index 0000000000..72ef691d01 --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-createGroupLiveMigration.txt @@ -0,0 +1,103 @@ +.. _atlas-api-cloudMigrationService-createGroupLiveMigration: + +======================================================== +atlas api cloudMigrationService createGroupLiveMigration +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Please make sure to validate your migration before initiating it. + + +You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. + + +NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategrouplivemigration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService createGroupLiveMigration [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupLiveMigration + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index 3170308e82..d9ea719b8c 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlinktoken. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorglivemigrationlinktoken. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,7 +59,7 @@ Options * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -71,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt deleted file mode 100644 index 14f134eceb..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-api-cloudMigrationService-createPushMigration: - -=================================================== -atlas api cloudMigrationService createPushMigration -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Please make sure to validate your migration before initiating it. - - -You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. - - -NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpushmigration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService createPushMigration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createPushMigration - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index f3b15a56d2..d63ba35372 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cutovermigration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cutovergrouplivemigration. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,7 +59,7 @@ Options * - --liveMigrationId - string - true - - Unique 24-hexadecimal digit string that identifies the migration. + - unique 24-hexadecimal digit string that identifies the migration * - -o, --output - string - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-cloudMigrationService-cutoverMigration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt deleted file mode 100644 index bda9c5c3ce..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-api-cloudMigrationService-deleteLinkToken: - -=============================================== -atlas api cloudMigrationService deleteLinkToken -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove one organization link and its associated public API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelinktoken. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService deleteLinkToken [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. - * - -h, --help - - - - false - - help for deleteLinkToken - * - --orgId - - string - - true - - 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. - * - -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) - * - --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-cloudMigrationService-deleteLinkToken-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkTokens.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkTokens.txt new file mode 100644 index 0000000000..5967cc69c1 --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkTokens.txt @@ -0,0 +1,87 @@ +.. _atlas-api-cloudMigrationService-deleteLinkTokens: + +================================================ +atlas api cloudMigrationService deleteLinkTokens +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove one organization link and its associated public API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorglivemigrationlinktokens. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService deleteLinkTokens [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for deleteLinkTokens + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-cloudMigrationService-getGroupLiveMigration.txt b/docs/command/atlas-api-cloudMigrationService-getGroupLiveMigration.txt new file mode 100644 index 0000000000..a853ce5a5f --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-getGroupLiveMigration.txt @@ -0,0 +1,102 @@ +.. _atlas-api-cloudMigrationService-getGroupLiveMigration: + +===================================================== +atlas api cloudMigrationService getGroupLiveMigration +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return details of one cluster migration job. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplivemigration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService getGroupLiveMigration [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 getGroupLiveMigration + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the migration. + * - -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. + * - --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-cloudMigrationService-getGroupLiveMigration-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-getMigrationValidateStatus.txt b/docs/command/atlas-api-cloudMigrationService-getMigrationValidateStatus.txt new file mode 100644 index 0000000000..b20a6dae84 --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-getMigrationValidateStatus.txt @@ -0,0 +1,91 @@ +.. _atlas-api-cloudMigrationService-getMigrationValidateStatus: + +========================================================== +atlas api cloudMigrationService getMigrationValidateStatus +========================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the status of one migration validation job. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Your API Key must have the Organization Owner role to successfully call this resource. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplivemigrationvalidatestatus. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService getMigrationValidateStatus [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getMigrationValidateStatus + * - -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) + * - --validationId + - string + - true + - unique 24-hexadecimal digit string that identifies the validation job + * - --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. + diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt deleted file mode 100644 index 71f413e666..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-cloudMigrationService-getPushMigration: - -================================================ -atlas api cloudMigrationService getPushMigration -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return details of one cluster migration job. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpushmigration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService getPushMigration [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 getPushMigration - * - --liveMigrationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the migration. - * - -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. - * - --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-cloudMigrationService-getPushMigration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt deleted file mode 100644 index 84846b38b2..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-cloudMigrationService-getValidationStatus: - -=================================================== -atlas api cloudMigrationService getValidationStatus -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the status of one migration validation job. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Your API Key must have the Organization Owner role to successfully call this resource. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getvalidationstatus. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService getValidationStatus [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 getValidationStatus - * - -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) - * - --validationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the validation job. - * - --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-cloudMigrationService-getValidationStatus-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-listAvailableProjects.txt b/docs/command/atlas-api-cloudMigrationService-listAvailableProjects.txt new file mode 100644 index 0000000000..c02913ed22 --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-listAvailableProjects.txt @@ -0,0 +1,89 @@ +.. _atlas-api-cloudMigrationService-listAvailableProjects: + +===================================================== +atlas api cloudMigrationService listAvailableProjects +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all projects that you can migrate to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listorglivemigrationavailableprojects. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService listAvailableProjects [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listAvailableProjects + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt deleted file mode 100644 index 5b76c31110..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-api-cloudMigrationService-listSourceProjects: - -================================================== -atlas api cloudMigrationService listSourceProjects -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all projects that you can migrate to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsourceprojects. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService listSourceProjects [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. - * - -h, --help - - - - false - - help for listSourceProjects - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-cloudMigrationService-listSourceProjects-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudMigrationService-validateLiveMigrations.txt b/docs/command/atlas-api-cloudMigrationService-validateLiveMigrations.txt new file mode 100644 index 0000000000..9e5b3a7758 --- /dev/null +++ b/docs/command/atlas-api-cloudMigrationService-validateLiveMigrations.txt @@ -0,0 +1,95 @@ +.. _atlas-api-cloudMigrationService-validateLiveMigrations: + +====================================================== +atlas api cloudMigrationService validateLiveMigrations +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validategrouplivemigrations. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudMigrationService validateLiveMigrations [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for validateLiveMigrations + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt deleted file mode 100644 index 3c7d2f533c..0000000000 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-cloudMigrationService-validateMigration: - -================================================= -atlas api cloudMigrationService validateMigration -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validatemigration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudMigrationService validateMigration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 validateMigration - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 9a03f52869..4065453e79 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -54,25 +54,25 @@ Inherited Options Related Commands ---------------- +* :ref:`atlas-api-cloudMigrationService-createGroupLiveMigration` - Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. * :ref:`atlas-api-cloudMigrationService-createLinkToken` - Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. * :ref:`atlas-api-cloudMigrationService-cutoverMigration` - Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +* :ref:`atlas-api-cloudMigrationService-deleteLinkTokens` - Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getGroupLiveMigration` - Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getMigrationValidateStatus` - Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listAvailableProjects` - Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateLiveMigrations` - Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. .. toctree:: :titlesonly: + createGroupLiveMigration createLinkToken - createPushMigration cutoverMigration - deleteLinkToken - getPushMigration - getValidationStatus - listSourceProjects - validateMigration + deleteLinkTokens + getGroupLiveMigration + getMigrationValidateStatus + listAvailableProjects + validateLiveMigrations diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt deleted file mode 100644 index 5856906dc5..0000000000 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole: - -============================================================== -atlas api cloudProviderAccess authorizeCloudProviderAccessRole -============================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Grants access to the specified project for the specified access role. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-authorizecloudprovideraccessrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudProviderAccess authorizeCloudProviderAccessRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 authorizeCloudProviderAccessRole - * - -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. - * - --roleId - - string - - true - - Unique 24-hexadecimal digit string that identifies the role. - * - --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. - diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeProviderAccessRole.txt new file mode 100644 index 0000000000..4f736f6de4 --- /dev/null +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeProviderAccessRole.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudProviderAccess-authorizeProviderAccessRole: + +========================================================= +atlas api cloudProviderAccess authorizeProviderAccessRole +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Grants access to the specified project for the specified access role. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-authorizegroupcloudprovideraccessrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudProviderAccess authorizeProviderAccessRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for authorizeProviderAccessRole + * - -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 + * - --roleId + - string + - true + - unique 24-hexadecimal digit string that identifies the role + * - --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. + diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccess.txt new file mode 100644 index 0000000000..a8aea81896 --- /dev/null +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccess.txt @@ -0,0 +1,95 @@ +.. _atlas-api-cloudProviderAccess-createCloudProviderAccess: + +======================================================= +atlas api cloudProviderAccess createCloudProviderAccess +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one access role for the specified cloud provider. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcloudprovideraccess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudProviderAccess createCloudProviderAccess [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createCloudProviderAccess + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt deleted file mode 100644 index 1abb3f0e51..0000000000 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-cloudProviderAccess-createCloudProviderAccessRole: - -=========================================================== -atlas api cloudProviderAccess createCloudProviderAccessRole -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one access role for the specified cloud provider. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcloudprovideraccessrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudProviderAccess createCloudProviderAccessRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createCloudProviderAccessRole - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt deleted file mode 100644 index c57a6eb0f0..0000000000 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole: - -================================================================ -atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole -================================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Revokes access to the specified project for the specified access role. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deauthorizecloudprovideraccessrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole [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 - * - --cloudProvider - - string - - true - - Human-readable label that identifies the cloud provider of the role to deauthorize. - * - --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 deauthorizeCloudProviderAccessRole - * - -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. - * - --roleId - - string - - true - - Unique 24-hexadecimal digit string that identifies the role. - * - --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-cloudProviderAccess-deauthorizeCloudProviderAccessRole-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeProviderAccessRole.txt new file mode 100644 index 0000000000..4a19442973 --- /dev/null +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeProviderAccessRole.txt @@ -0,0 +1,99 @@ +.. _atlas-api-cloudProviderAccess-deauthorizeProviderAccessRole: + +=========================================================== +atlas api cloudProviderAccess deauthorizeProviderAccessRole +=========================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Revokes access to the specified project for the specified access role. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deauthorizegroupcloudprovideraccessrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudProviderAccess deauthorizeProviderAccessRole [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 + * - --cloudProvider + - string + - true + - human-readable label that identifies the cloud provider of the role to deauthorize + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deauthorizeProviderAccessRole + * - -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 + * - --roleId + - string + - true + - unique 24-hexadecimal digit string that identifies the role + * - --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. + diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccess.txt new file mode 100644 index 0000000000..25169c1e17 --- /dev/null +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccess.txt @@ -0,0 +1,95 @@ +.. _atlas-api-cloudProviderAccess-getCloudProviderAccess: + +==================================================== +atlas api cloudProviderAccess getCloudProviderAccess +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the access role with the specified id and with access to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcloudprovideraccess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudProviderAccess getCloudProviderAccess [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getCloudProviderAccess + * - -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 + * - --roleId + - string + - true + - unique 24-hexadecimal digit string that identifies the role + * - --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. + diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt deleted file mode 100644 index 2e4aea81dd..0000000000 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-cloudProviderAccess-getCloudProviderAccessRole: - -======================================================== -atlas api cloudProviderAccess getCloudProviderAccessRole -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the access role with the specified id and with access to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcloudprovideraccessrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudProviderAccess getCloudProviderAccessRole [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 getCloudProviderAccessRole - * - -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. - * - --roleId - - string - - true - - Unique 24-hexadecimal digit string that identifies the role. - * - --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-cloudProviderAccess-getCloudProviderAccessRole-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccess.txt new file mode 100644 index 0000000000..5b353033a8 --- /dev/null +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccess.txt @@ -0,0 +1,91 @@ +.. _atlas-api-cloudProviderAccess-listCloudProviderAccess: + +===================================================== +atlas api cloudProviderAccess listCloudProviderAccess +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all cloud provider access roles with access to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcloudprovideraccess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api cloudProviderAccess listCloudProviderAccess [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listCloudProviderAccess + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt deleted file mode 100644 index d626b2a834..0000000000 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-cloudProviderAccess-listCloudProviderAccessRoles: - -========================================================== -atlas api cloudProviderAccess listCloudProviderAccessRoles -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all cloud provider access roles with access to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudprovideraccessroles. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api cloudProviderAccess listCloudProviderAccessRoles [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 listCloudProviderAccessRoles - * - -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. - * - --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-cloudProviderAccess-listCloudProviderAccessRoles-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index c8088bc4fb..57c16a8d33 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -54,19 +54,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeProviderAccessRole` - Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccess` - Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeProviderAccessRole` - Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccess` - Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccess` - Returns all cloud provider access roles with access to the specified project. .. toctree:: :titlesonly: - authorizeCloudProviderAccessRole - createCloudProviderAccessRole - deauthorizeCloudProviderAccessRole - getCloudProviderAccessRole - listCloudProviderAccessRoles + authorizeProviderAccessRole + createCloudProviderAccess + deauthorizeProviderAccessRole + getCloudProviderAccess + listCloudProviderAccess diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index 64834edc35..af258ba15e 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -17,7 +17,7 @@ Ends a cluster outage simulation. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-endoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-endgroupclusteroutagesimulation. For more information and examples, see the referenced API documentation linked above. @@ -45,17 +45,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster that is undergoing outage simulation. + - human-readable label that identifies the cluster that is undergoing outage simulation * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -71,7 +69,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -101,8 +99,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusterOutageSimulation-endOutageSimulation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index a218d7fcd5..4df7d35393 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -17,7 +17,7 @@ Returns one outage simulation for one cluster. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusteroutagesimulation. For more information and examples, see the referenced API documentation linked above. @@ -45,17 +45,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster that is undergoing outage simulation. + - human-readable label that identifies the cluster that is undergoing outage simulation * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -71,7 +69,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -93,8 +91,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusterOutageSimulation-getOutageSimulation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index 5f8f61b359..0dafc23104 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -17,7 +17,7 @@ Starts a cluster outage simulation. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupclusteroutagesimulation. For more information and examples, see the referenced API documentation linked above. @@ -45,11 +45,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster to undergo an outage simulation. + - human-readable label that identifies the cluster to undergo an outage simulation * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -57,9 +57,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -75,7 +73,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index 4c2035b567..014dee0e4e 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-autoscalingconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-autogroupclusterscalingconfiguration. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-autoScalingConfiguration-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 27ab5876a7..ec8856901a 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -22,7 +22,7 @@ Clusters contain a group of hosts that maintain the same data set. This resource Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcluster. For more information and examples, see the referenced API documentation linked above. @@ -48,9 +48,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -58,9 +58,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -106,47 +104,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. tabs:: - - .. tab:: Example - :tabid: 2024-08-05_cluster - - Cluster - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-08-05-cluster-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-08-05-cluster.sh - :language: shell - .. tab:: Example 1 - :tabid: 2024-10-23_cluster - - Cluster - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-cluster-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-cluster.sh - :language: shell - .. tab:: Create a basic MongoDB Atlas cluster - :tabid: 2024-10-23_create_cluster - - Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-create_cluster-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-create_cluster.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index d1d2a2ba82..371bcf5857 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -22,7 +22,7 @@ The cluster must have termination protection disabled in order to be deleted. To This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcluster. For more information and examples, see the referenced API documentation linked above. @@ -50,17 +50,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,11 +74,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --retainBackups - - false - - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. + - flag that indicates whether to retain backup snapshots for the deleted dedicated cluster * - --version - string - false @@ -110,8 +108,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-deleteCluster-2023-02-01-delete_cluster.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index a592153b08..3865d6052d 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -22,7 +22,7 @@ Clusters contain a group of hosts that maintain the same data set. The response This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcluster. For more information and examples, see the referenced API documentation linked above. @@ -50,17 +50,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -98,8 +96,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-getCluster-2024-08-05-get_cluster.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt deleted file mode 100644 index 29ee73a906..0000000000 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-clusters-getClusterAdvancedConfiguration: - -================================================== -atlas api clusters getClusterAdvancedConfiguration -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the advanced configuration details for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusteradvancedconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters getClusterAdvancedConfiguration [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 getClusterAdvancedConfiguration - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-clusters-getClusterAdvancedConfiguration-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index a94da30db0..2d2066e4ea 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusterstatus. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterstatus. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-getClusterStatus-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-getProcessArgs.txt b/docs/command/atlas-api-clusters-getProcessArgs.txt new file mode 100644 index 0000000000..0f6221f354 --- /dev/null +++ b/docs/command/atlas-api-clusters-getProcessArgs.txt @@ -0,0 +1,95 @@ +.. _atlas-api-clusters-getProcessArgs: + +================================= +atlas api clusters getProcessArgs +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the advanced configuration details for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterprocessargs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters getProcessArgs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getProcessArgs + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoad.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoad.txt new file mode 100644 index 0000000000..8919f2b95d --- /dev/null +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoad.txt @@ -0,0 +1,91 @@ +.. _atlas-api-clusters-getSampleDatasetLoad: + +======================================= +atlas api clusters getSampleDatasetLoad +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Checks the progress of loading the sample dataset into one cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupsampledatasetload. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters getSampleDatasetLoad [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getSampleDatasetLoad + * - -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) + * - --sampleDatasetId + - string + - true + - unique 24-hexadecimal digit string that identifies the loaded sample dataset + * - --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. + diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt deleted file mode 100644 index 021b5d48aa..0000000000 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-clusters-getSampleDatasetLoadStatus: - -============================================= -atlas api clusters getSampleDatasetLoadStatus -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Checks the progress of loading the sample dataset into one cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsampledatasetloadstatus. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters getSampleDatasetLoadStatus [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 getSampleDatasetLoadStatus - * - -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) - * - --sampleDatasetId - - string - - true - - Unique 24-hexadecimal digit string that identifies the loaded sample dataset. - * - --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-clusters-getSampleDatasetLoadStatus-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt deleted file mode 100644 index 7ad008f1d0..0000000000 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-clusters-grantMongoDbEmployeeAccess: - -============================================= -atlas api clusters grantMongoDbEmployeeAccess -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-grantmongodbemployeeaccess. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters grantMongoDbEmployeeAccess [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 this 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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 grantMongoDbEmployeeAccess - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-clusters-grantMongoEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoEmployeeAccess.txt new file mode 100644 index 0000000000..969b7abb11 --- /dev/null +++ b/docs/command/atlas-api-clusters-grantMongoEmployeeAccess.txt @@ -0,0 +1,97 @@ +.. _atlas-api-clusters-grantMongoEmployeeAccess: + +=========================================== +atlas api clusters grantMongoEmployeeAccess +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-grantgroupclustermongodbemployeeaccess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters grantMongoEmployeeAccess [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 this cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for grantMongoEmployeeAccess + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt deleted file mode 100644 index 97e8007829..0000000000 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-api-clusters-listCloudProviderRegions: - -=========================================== -atlas api clusters listCloudProviderRegions -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the list of regions available for the specified cloud provider at the specified tier. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudproviderregions. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters listCloudProviderRegions [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 listCloudProviderRegions - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --providers - - stringArray - - false - - Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters. - * - --tier - - string - - false - - Cluster tier for which to retrieve the regions. - * - --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-clusters-listCloudProviderRegions-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-listClusterDetails.txt b/docs/command/atlas-api-clusters-listClusterDetails.txt new file mode 100644 index 0000000000..c93352cf46 --- /dev/null +++ b/docs/command/atlas-api-clusters-listClusterDetails.txt @@ -0,0 +1,99 @@ +.. _atlas-api-clusters-listClusterDetails: + +===================================== +atlas api clusters listClusterDetails +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details for all clusters in all projects to which you have access. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusterdetails. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters listClusterDetails [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. + * - -h, --help + - + - false + - help for listClusterDetails + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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. + diff --git a/docs/command/atlas-api-clusters-listClusterProviderRegions.txt b/docs/command/atlas-api-clusters-listClusterProviderRegions.txt new file mode 100644 index 0000000000..37e52cc001 --- /dev/null +++ b/docs/command/atlas-api-clusters-listClusterProviderRegions.txt @@ -0,0 +1,111 @@ +.. _atlas-api-clusters-listClusterProviderRegions: + +============================================= +atlas api clusters listClusterProviderRegions +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the list of regions available for the specified cloud provider at the specified tier. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterproviderregions. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters listClusterProviderRegions [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterProviderRegions + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --providers + - stringArray + - false + - cloud providers whose regions to retrieve + * - --tier + - string + - false + - cluster tier for which to retrieve the regions + * - --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. + diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index f36ae48865..d68dc8f90a 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -22,7 +22,7 @@ Clusters contain a group of hosts that maintain the same data set. The response This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusters. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusters. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -64,15 +62,15 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --includeDeletedWithRetainedBackups - - false - - Flag that indicates whether to return Clusters with retain backups. + - flag that indicates whether to return Clusters with retain backups * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -84,11 +82,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -110,8 +108,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-listClusters-2024-08-05-list_clusters.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt deleted file mode 100644 index a04731e05c..0000000000 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-clusters-listClustersForAllProjects: - -============================================= -atlas api clusters listClustersForAllProjects -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details for all clusters in all projects to which you have access. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersforallprojects. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters listClustersForAllProjects [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. - * - -h, --help - - - - false - - help for listClustersForAllProjects - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt deleted file mode 100644 index ae7cb6c534..0000000000 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-clusters-loadSampleDataset: - -==================================== -atlas api clusters loadSampleDataset -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Requests loading the MongoDB sample dataset into the specified cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-loadsampledataset. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters loadSampleDataset [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 loadSampleDataset - * - --name - - string - - true - - Human-readable label that identifies the cluster into which you load the sample dataset. - * - -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) - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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-clusters-loadSampleDataset-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 23d2c0af0c..e498e32e06 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinfeaturecompatibilityversion. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pingroupclusterfeaturecompatibilityversion. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-clusters-requestSampleDatasetLoad.txt b/docs/command/atlas-api-clusters-requestSampleDatasetLoad.txt new file mode 100644 index 0000000000..ec0e9e4173 --- /dev/null +++ b/docs/command/atlas-api-clusters-requestSampleDatasetLoad.txt @@ -0,0 +1,99 @@ +.. _atlas-api-clusters-requestSampleDatasetLoad: + +=========================================== +atlas api clusters requestSampleDatasetLoad +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Requests loading the MongoDB sample dataset into the specified cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-requestgroupsampledatasetload. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters requestSampleDatasetLoad [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for requestSampleDatasetLoad + * - --name + - string + - true + - human-readable label that identifies the cluster into which you load the sample dataset + * - -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) + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-clusters-restartPrimaries.txt b/docs/command/atlas-api-clusters-restartPrimaries.txt new file mode 100644 index 0000000000..247ba82b9d --- /dev/null +++ b/docs/command/atlas-api-clusters-restartPrimaries.txt @@ -0,0 +1,95 @@ +.. _atlas-api-clusters-restartPrimaries: + +=================================== +atlas api clusters restartPrimaries +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Starts a failover test for the specified cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-restartgroupclusterprimaries. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters restartPrimaries [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for restartPrimaries + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt deleted file mode 100644 index 122709bbbd..0000000000 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-clusters-revokeMongoDbEmployeeAccess: - -============================================== -atlas api clusters revokeMongoDbEmployeeAccess -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Revokes a previously granted MongoDB employee cluster access. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokemongodbemployeeaccess. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters revokeMongoDbEmployeeAccess [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 this 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 revokeMongoDbEmployeeAccess - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-clusters-revokeMongoDbEmployeeAccess-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-revokeMongoEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoEmployeeAccess.txt new file mode 100644 index 0000000000..3aa14f2303 --- /dev/null +++ b/docs/command/atlas-api-clusters-revokeMongoEmployeeAccess.txt @@ -0,0 +1,93 @@ +.. _atlas-api-clusters-revokeMongoEmployeeAccess: + +============================================ +atlas api clusters revokeMongoEmployeeAccess +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Revokes a previously granted MongoDB employee cluster access. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-revokegroupclustermongodbemployeeaccess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters revokeMongoEmployeeAccess [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 this cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for revokeMongoEmployeeAccess + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt deleted file mode 100644 index 52f363732a..0000000000 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-clusters-testFailover: - -=============================== -atlas api clusters testFailover -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Starts a failover test for the specified cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-testfailover. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters testFailover [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 testFailover - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-clusters-testFailover-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index e4190cc5c2..5adca0c90c 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This feature is not available for clusters on rapid release. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpinfeaturecompatibilityversion. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpingroupclusterfeaturecompatibilityversion. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-clusters-unpinFeatureCompatibilityVersion-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 16b2e16d0a..6c58fbe778 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcluster. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -107,16 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -Updates the cluster to increase disk size to 20GB and increase node count to 5 - -Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-clusters-updateCluster-2024-10-23-update_cluster-payload.json - :language: shell -After creating ``payload.json``, run the command below in the same directory. - -.. literalinclude:: /includes/examples/atlas-api-clusters-updateCluster-2024-10-23-update_cluster.sh - :language: shell diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt deleted file mode 100644 index 79e5e43daa..0000000000 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-clusters-updateClusterAdvancedConfiguration: - -===================================================== -atlas api clusters updateClusterAdvancedConfiguration -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the advanced configuration details for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateclusteradvancedconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters updateClusterAdvancedConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateClusterAdvancedConfiguration - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-clusters-updateProcessArgs.txt b/docs/command/atlas-api-clusters-updateProcessArgs.txt new file mode 100644 index 0000000000..303482538c --- /dev/null +++ b/docs/command/atlas-api-clusters-updateProcessArgs.txt @@ -0,0 +1,99 @@ +.. _atlas-api-clusters-updateProcessArgs: + +==================================== +atlas api clusters updateProcessArgs +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the advanced configuration details for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterprocessargs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters updateProcessArgs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateProcessArgs + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt deleted file mode 100644 index 04d16109da..0000000000 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-clusters-upgradeSharedCluster: - -======================================= -atlas api clusters upgradeSharedCluster -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. - - -This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradesharedcluster. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api clusters upgradeSharedCluster [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 upgradeSharedCluster - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-clusters-upgradeTenantUpgrade.txt b/docs/command/atlas-api-clusters-upgradeTenantUpgrade.txt new file mode 100644 index 0000000000..d3c860cdf5 --- /dev/null +++ b/docs/command/atlas-api-clusters-upgradeTenantUpgrade.txt @@ -0,0 +1,98 @@ +.. _atlas-api-clusters-upgradeTenantUpgrade: + +======================================= +atlas api clusters upgradeTenantUpgrade +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. + + +This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradegroupclustertenantupgrade. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api clusters upgradeTenantUpgrade [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for upgradeTenantUpgrade + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index 3cba9bb6cd..4bee643dc9 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -58,21 +58,21 @@ Related Commands * :ref:`atlas-api-clusters-createCluster` - Creates one cluster in the specified project. * :ref:`atlas-api-clusters-deleteCluster` - Removes one cluster from the specified project. * :ref:`atlas-api-clusters-getCluster` - Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - Returns the advanced configuration details for one cluster in the specified project. * :ref:`atlas-api-clusters-getClusterStatus` - Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-getProcessArgs` - Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoad` - Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoEmployeeAccess` - Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listClusterDetails` - Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-listClusterProviderRegions` - Returns the list of regions available for the specified cloud provider at the specified tier. * :ref:`atlas-api-clusters-listClusters` - Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - Requests loading the MongoDB sample dataset into the specified cluster. * :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-requestSampleDatasetLoad` - Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-restartPrimaries` - Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-revokeMongoEmployeeAccess` - Revokes a previously granted MongoDB employee cluster access. * :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - Unpins the current fixed Feature Compatibility Version (FCV). * :ref:`atlas-api-clusters-updateCluster` - Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :ref:`atlas-api-clusters-updateProcessArgs` - Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeTenantUpgrade` - Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. .. toctree:: @@ -82,19 +82,19 @@ Related Commands createCluster deleteCluster getCluster - getClusterAdvancedConfiguration getClusterStatus - getSampleDatasetLoadStatus - grantMongoDbEmployeeAccess - listCloudProviderRegions + getProcessArgs + getSampleDatasetLoad + grantMongoEmployeeAccess + listClusterDetails + listClusterProviderRegions listClusters - listClustersForAllProjects - loadSampleDataset pinFeatureCompatibilityVersion - revokeMongoDbEmployeeAccess - testFailover + requestSampleDatasetLoad + restartPrimaries + revokeMongoEmployeeAccess unpinFeatureCompatibilityVersion updateCluster - updateClusterAdvancedConfiguration - upgradeSharedCluster + updateProcessArgs + upgradeTenantUpgrade diff --git a/docs/command/atlas-api-collectionLevelMetrics-getClusterNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getClusterNamespaces.txt new file mode 100644 index 0000000000..642dff2cfb --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-getClusterNamespaces.txt @@ -0,0 +1,105 @@ +.. _atlas-api-collectionLevelMetrics-getClusterNamespaces: + +===================================================== +atlas api collectionLevelMetrics getClusterNamespaces +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupclustercollstatnamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics getClusterNamespaces [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 to pin namespaces to + * - --clusterView + - string + - true + - human-readable label that identifies the cluster topology to retrieve metrics for + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterNamespaces + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt deleted file mode 100644 index 7568a29d8f..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ /dev/null @@ -1,124 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements: - -================================================================================ -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements -================================================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespaceclustermeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements [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 to retrieve metrics for. - * - --clusterView - - string - - true - - Human-readable label that identifies the cluster topology to retrieve metrics for. - * - --collectionName - - string - - true - - Human-readable label that identifies the collection. - * - --databaseName - - string - - true - - Human-readable label that identifies the database. - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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 getCollStatsLatencyNamespaceClusterMeasurements - * - --metrics - - stringArray - - false - - List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt deleted file mode 100644 index f0bbaaca49..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements: - -============================================================================= -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements -============================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a list of the Coll Stats Latency process-level measurements for the given namespace. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacehostmeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements [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 - * - --collectionName - - string - - true - - Human-readable label that identifies the collection. - * - --databaseName - - string - - true - - Human-readable label that identifies the database. - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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 getCollStatsLatencyNamespaceHostMeasurements - * - --metrics - - stringArray - - false - - List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt deleted file mode 100644 index b0fd7fcd5f..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics: - -==================================================================== -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics -==================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacemetrics. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics [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 getCollStatsLatencyNamespaceMetrics - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt deleted file mode 100644 index 24fc6c52e7..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster: - -======================================================================== -atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster -======================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforcluster. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster [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 to pin namespaces to. - * - --clusterView - - string - - true - - Human-readable label that identifies the cluster topology to retrieve metrics for. - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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 getCollStatsLatencyNamespacesForCluster - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt deleted file mode 100644 index 192629b53a..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost: - -===================================================================== -atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost -===================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforhost. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost [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 - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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 getCollStatsLatencyNamespacesForHost - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt deleted file mode 100644 index 4802c98956..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-getPinnedNamespaces: - -==================================================== -atlas api collectionLevelMetrics getPinnedNamespaces -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpinnednamespaces. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics getPinnedNamespaces [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 to retrieve pinned namespaces for. - * - --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 getPinnedNamespaces - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-collectionLevelMetrics-getPinnedNamespaces-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-collectionLevelMetrics-getProcessNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getProcessNamespaces.txt new file mode 100644 index 0000000000..e7369c1457 --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-getProcessNamespaces.txt @@ -0,0 +1,101 @@ +.. _atlas-api-collectionLevelMetrics-getProcessNamespaces: + +===================================================== +atlas api collectionLevelMetrics getProcessNamespaces +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupprocesscollstatnamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics getProcessNamespaces [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 + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getProcessNamespaces + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-listCollStatMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-listCollStatMeasurements.txt new file mode 100644 index 0000000000..ca8e86a66e --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-listCollStatMeasurements.txt @@ -0,0 +1,117 @@ +.. _atlas-api-collectionLevelMetrics-listCollStatMeasurements: + +========================================================= +atlas api collectionLevelMetrics listCollStatMeasurements +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupclustercollstatmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics listCollStatMeasurements [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 to retrieve metrics for + * - --clusterView + - string + - true + - human-readable label that identifies the cluster topology to retrieve metrics for + * - --collectionName + - string + - true + - human-readable label that identifies the collection + * - --databaseName + - string + - true + - human-readable label that identifies the database + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listCollStatMeasurements + * - --metrics + - stringArray + - false + - list that contains the metrics that you want to retrieve for the associated data series + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-listCollStatMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-listCollStatMetrics.txt new file mode 100644 index 0000000000..aa684accff --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-listCollStatMetrics.txt @@ -0,0 +1,85 @@ +.. _atlas-api-collectionLevelMetrics-listCollStatMetrics: + +==================================================== +atlas api collectionLevelMetrics listCollStatMetrics +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupcollstatmetrics. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics listCollStatMetrics [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listCollStatMetrics + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-listPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-listPinnedNamespaces.txt new file mode 100644 index 0000000000..f47b26056b --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-listPinnedNamespaces.txt @@ -0,0 +1,89 @@ +.. _atlas-api-collectionLevelMetrics-listPinnedNamespaces: + +===================================================== +atlas api collectionLevelMetrics listPinnedNamespaces +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupclustercollstatpinnednamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics listPinnedNamespaces [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 to retrieve pinned namespaces for + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listPinnedNamespaces + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-listProcessMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-listProcessMeasurements.txt new file mode 100644 index 0000000000..0adb1d338f --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-listProcessMeasurements.txt @@ -0,0 +1,113 @@ +.. _atlas-api-collectionLevelMetrics-listProcessMeasurements: + +======================================================== +atlas api collectionLevelMetrics listProcessMeasurements +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get a list of the Coll Stats Latency process-level measurements for the given namespace. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupprocesscollstatmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics listProcessMeasurements [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 + * - --collectionName + - string + - true + - human-readable label that identifies the collection + * - --databaseName + - string + - true + - human-readable label that identifies the database + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listProcessMeasurements + * - --metrics + - stringArray + - false + - list that contains the metrics that you want to retrieve for the associated data series + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespaces.txt new file mode 100644 index 0000000000..58d87cf8e6 --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespaces.txt @@ -0,0 +1,95 @@ +.. _atlas-api-collectionLevelMetrics-pinNamespaces: + +============================================== +atlas api collectionLevelMetrics pinNamespaces +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pingroupclustercollstatpinnednamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics pinNamespaces [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 to pin namespaces to + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for pinNamespaces + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt deleted file mode 100644 index a9aaae3fba..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-pinNamespacesPatch: - -=================================================== -atlas api collectionLevelMetrics pinNamespacesPatch -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacespatch. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics pinNamespacesPatch [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 to pin namespaces to. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 pinNamespacesPatch - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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. - diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt deleted file mode 100644 index c48607de17..0000000000 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-collectionLevelMetrics-pinNamespacesPut: - -================================================= -atlas api collectionLevelMetrics pinNamespacesPut -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacesput. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api collectionLevelMetrics pinNamespacesPut [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 to pin namespaces to. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 pinNamespacesPut - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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. - diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 2ad8558d5a..b511bf4297 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -17,7 +17,7 @@ Unpin provided list of namespaces for collection-level latency metrics collectio The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpinnamespaces. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpingroupclustercollstatunpinnamespaces. For more information and examples, see the referenced API documentation linked above. @@ -45,11 +45,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster to unpin namespaces from. + - human-readable label that identifies the cluster to unpin namespaces from * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -57,9 +57,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false diff --git a/docs/command/atlas-api-collectionLevelMetrics-updatePinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-updatePinnedNamespaces.txt new file mode 100644 index 0000000000..32b5e70bbd --- /dev/null +++ b/docs/command/atlas-api-collectionLevelMetrics-updatePinnedNamespaces.txt @@ -0,0 +1,93 @@ +.. _atlas-api-collectionLevelMetrics-updatePinnedNamespaces: + +======================================================= +atlas api collectionLevelMetrics updatePinnedNamespaces +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-updategroupclustercollstatpinnednamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api collectionLevelMetrics updatePinnedNamespaces [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 to pin namespaces to + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updatePinnedNamespaces + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 7c98c6d7ab..22a2626430 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -54,27 +54,27 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - Get a list of the Coll Stats Latency process-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-getClusterNamespaces` - Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-getProcessNamespaces` - Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-listCollStatMeasurements` - Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-listCollStatMetrics` - Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +* :ref:`atlas-api-collectionLevelMetrics-listPinnedNamespaces` - Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +* :ref:`atlas-api-collectionLevelMetrics-listProcessMeasurements` - Get a list of the Coll Stats Latency process-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespaces` - Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. * :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-updatePinnedNamespaces` - Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. .. toctree:: :titlesonly: - getCollStatsLatencyNamespaceClusterMeasurements - getCollStatsLatencyNamespaceHostMeasurements - getCollStatsLatencyNamespaceMetrics - getCollStatsLatencyNamespacesForCluster - getCollStatsLatencyNamespacesForHost - getPinnedNamespaces - pinNamespacesPatch - pinNamespacesPut + getClusterNamespaces + getProcessNamespaces + listCollStatMeasurements + listCollStatMetrics + listPinnedNamespaces + listProcessMeasurements + pinNamespaces unpinNamespaces + updatePinnedNamespaces diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt deleted file mode 100644 index 0279d4e850..0000000000 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-customDatabaseRoles-createCustomDatabaseRole: - -====================================================== -atlas api customDatabaseRoles createCustomDatabaseRole -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one custom role in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomdatabaserole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api customDatabaseRoles createCustomDatabaseRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createCustomDatabaseRole - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDbRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDbRole.txt new file mode 100644 index 0000000000..c187338df4 --- /dev/null +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDbRole.txt @@ -0,0 +1,95 @@ +.. _atlas-api-customDatabaseRoles-createCustomDbRole: + +================================================ +atlas api customDatabaseRoles createCustomDbRole +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one custom role in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcustomdbrolerole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api customDatabaseRoles createCustomDbRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createCustomDbRole + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt deleted file mode 100644 index 5f1afb7114..0000000000 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-customDatabaseRoles-deleteCustomDatabaseRole: - -====================================================== -atlas api customDatabaseRoles deleteCustomDatabaseRole -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one custom role from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecustomdatabaserole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api customDatabaseRoles deleteCustomDatabaseRole [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 deleteCustomDatabaseRole - * - -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. - * - --roleName - - string - - true - - Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. - * - --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-customDatabaseRoles-deleteCustomDatabaseRole-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDbRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDbRole.txt new file mode 100644 index 0000000000..e2d23ade29 --- /dev/null +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDbRole.txt @@ -0,0 +1,95 @@ +.. _atlas-api-customDatabaseRoles-deleteCustomDbRole: + +================================================ +atlas api customDatabaseRoles deleteCustomDbRole +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one custom role from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcustomdbrolerole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api customDatabaseRoles deleteCustomDbRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteCustomDbRole + * - -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 + * - --roleName + - string + - true + - human-readable label that identifies the role for the request + * - --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. + diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt deleted file mode 100644 index c6fd0e79f3..0000000000 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-customDatabaseRoles-getCustomDatabaseRole: - -=================================================== -atlas api customDatabaseRoles getCustomDatabaseRole -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one custom role for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcustomdatabaserole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api customDatabaseRoles getCustomDatabaseRole [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 getCustomDatabaseRole - * - -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. - * - --roleName - - string - - true - - Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. - * - --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-customDatabaseRoles-getCustomDatabaseRole-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDbRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDbRole.txt new file mode 100644 index 0000000000..c27da19663 --- /dev/null +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDbRole.txt @@ -0,0 +1,95 @@ +.. _atlas-api-customDatabaseRoles-getCustomDbRole: + +============================================= +atlas api customDatabaseRoles getCustomDbRole +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one custom role for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcustomdbrolerole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api customDatabaseRoles getCustomDbRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getCustomDbRole + * - -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 + * - --roleName + - string + - true + - human-readable label that identifies the role for the request + * - --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. + diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt deleted file mode 100644 index 9ceeec7037..0000000000 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-customDatabaseRoles-listCustomDatabaseRoles: - -===================================================== -atlas api customDatabaseRoles listCustomDatabaseRoles -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all custom roles for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcustomdatabaseroles. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api customDatabaseRoles listCustomDatabaseRoles [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 listCustomDatabaseRoles - * - -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. - * - --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-customDatabaseRoles-listCustomDatabaseRoles-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDbRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDbRoles.txt new file mode 100644 index 0000000000..50156521db --- /dev/null +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDbRoles.txt @@ -0,0 +1,91 @@ +.. _atlas-api-customDatabaseRoles-listCustomDbRoles: + +=============================================== +atlas api customDatabaseRoles listCustomDbRoles +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all custom roles for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcustomdbroleroles. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api customDatabaseRoles listCustomDbRoles [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listCustomDbRoles + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt deleted file mode 100644 index bed132dcab..0000000000 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-customDatabaseRoles-updateCustomDatabaseRole: - -====================================================== -atlas api customDatabaseRoles updateCustomDatabaseRole -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one custom role in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecustomdatabaserole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api customDatabaseRoles updateCustomDatabaseRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateCustomDatabaseRole - * - -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. - * - --roleName - - string - - true - - Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project. - * - --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. - diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDbRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDbRole.txt new file mode 100644 index 0000000000..86288f4053 --- /dev/null +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDbRole.txt @@ -0,0 +1,99 @@ +.. _atlas-api-customDatabaseRoles-updateCustomDbRole: + +================================================ +atlas api customDatabaseRoles updateCustomDbRole +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one custom role in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcustomdbrolerole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api customDatabaseRoles updateCustomDbRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateCustomDbRole + * - -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 + * - --roleName + - string + - true + - human-readable label that identifies the role for the request + * - --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. + diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index d36989cd3e..2b25a5c3aa 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -54,19 +54,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDbRole` - Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDbRole` - Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDbRole` - Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDbRoles` - Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDbRole` - Updates one custom role in the specified project. .. toctree:: :titlesonly: - createCustomDatabaseRole - deleteCustomDatabaseRole - getCustomDatabaseRole - listCustomDatabaseRoles - updateCustomDatabaseRole + createCustomDbRole + deleteCustomDbRole + getCustomDbRole + listCustomDbRoles + updateCustomDbRole diff --git a/docs/command/atlas-api-dataFederation-createDataFederation.txt b/docs/command/atlas-api-dataFederation-createDataFederation.txt new file mode 100644 index 0000000000..0b4576eb03 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-createDataFederation.txt @@ -0,0 +1,99 @@ +.. _atlas-api-dataFederation-createDataFederation: + +============================================= +atlas api dataFederation createDataFederation +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one federated database instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatafederation. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation createDataFederation [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createDataFederation + * - -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 + * - --skipRoleValidation + - + - false + - flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt deleted file mode 100644 index 3d9209b6e8..0000000000 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ /dev/null @@ -1,124 +0,0 @@ -.. _atlas-api-dataFederation-createDataFederationPrivateEndpoint: - -============================================================ -atlas api dataFederation createDataFederationPrivateEndpoint -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. - - -us-east-1 is com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. - - -us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb. - - -eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. - - -eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. - - -eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. - - -sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044. - - -ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. - - -ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. - - -To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatafederationprivateendpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation createDataFederationPrivateEndpoint [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createDataFederationPrivateEndpoint - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt deleted file mode 100644 index d87a6af047..0000000000 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-dataFederation-createFederatedDatabase: - -================================================ -atlas api dataFederation createFederatedDatabase -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one federated database instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederateddatabase. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation createFederatedDatabase [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createFederatedDatabase - * - -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. - * - --skipRoleValidation - - - - false - - Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. - * - --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. - diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt deleted file mode 100644 index ea96f88187..0000000000 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-dataFederation-createOneDataFederationQueryLimit: - -========================================================== -atlas api dataFederation createOneDataFederationQueryLimit -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates or updates one query limit for one federated database instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonedatafederationquerylimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation createOneDataFederationQueryLimit [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createOneDataFederationQueryLimit - * - --limitName - - string - - true - - Human-readable label that identifies this data federation instance limit. - - | Limit Name | Description | Default | - | --- | --- | --- | - | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | - | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | - | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | - | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - - * - -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) - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance to which the query limit applies. - * - --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. - diff --git a/docs/command/atlas-api-dataFederation-createPrivateEndpointId.txt b/docs/command/atlas-api-dataFederation-createPrivateEndpointId.txt new file mode 100644 index 0000000000..28db0db1cf --- /dev/null +++ b/docs/command/atlas-api-dataFederation-createPrivateEndpointId.txt @@ -0,0 +1,122 @@ +.. _atlas-api-dataFederation-createPrivateEndpointId: + +================================================ +atlas api dataFederation createPrivateEndpointId +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. + + +us-east-1 is com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. + + +us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb. + + +eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. + + +eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. + + +eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. + + +sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044. + + +ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. + + +ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivatenetworksettingendpointid. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation createPrivateEndpointId [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createPrivateEndpointId + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederation.txt b/docs/command/atlas-api-dataFederation-deleteDataFederation.txt new file mode 100644 index 0000000000..16ca718a23 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-deleteDataFederation.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-deleteDataFederation: + +============================================= +atlas api dataFederation deleteDataFederation +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one federated database instance from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatafederation. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation deleteDataFederation [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteDataFederation + * - -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 + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance to remove + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationLimit.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationLimit.txt new file mode 100644 index 0000000000..c444205cd2 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationLimit.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-deleteDataFederationLimit: + +================================================== +atlas api dataFederation deleteDataFederationLimit +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes one query limit for one federated database instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatafederationlimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation deleteDataFederationLimit [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteDataFederationLimit + * - --limitName + - string + - true + - human-readable label that identifies this data federation instance limit + * - -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) + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance to which the query limit applies + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt deleted file mode 100644 index 5185b46523..0000000000 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-deleteDataFederationPrivateEndpoint: - -============================================================ -atlas api dataFederation deleteDataFederationPrivateEndpoint -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatafederationprivateendpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation deleteDataFederationPrivateEndpoint [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 - * - --endpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. - * - --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 deleteDataFederationPrivateEndpoint - * - -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. - * - --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-dataFederation-deleteDataFederationPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt deleted file mode 100644 index c28dc14550..0000000000 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-deleteFederatedDatabase: - -================================================ -atlas api dataFederation deleteFederatedDatabase -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one federated database instance from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederateddatabase. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation deleteFederatedDatabase [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 deleteFederatedDatabase - * - -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. - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance to remove. - * - --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-dataFederation-deleteFederatedDatabase-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt deleted file mode 100644 index 30cbec8be6..0000000000 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit: - -================================================================== -atlas api dataFederation deleteOneDataFederationInstanceQueryLimit -================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes one query limit for one federated database instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonedatafederationinstancequerylimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation deleteOneDataFederationInstanceQueryLimit [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 deleteOneDataFederationInstanceQueryLimit - * - --limitName - - string - - true - - Human-readable label that identifies this data federation instance limit. - - | Limit Name | Description | Default | - | --- | --- | --- | - | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | - | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | - | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | - | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - - * - -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) - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance to which the query limit applies. - * - --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-dataFederation-deleteOneDataFederationInstanceQueryLimit-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-deletePrivateEndpointId.txt b/docs/command/atlas-api-dataFederation-deletePrivateEndpointId.txt new file mode 100644 index 0000000000..ee45ccab49 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-deletePrivateEndpointId.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-deletePrivateEndpointId: + +================================================ +atlas api dataFederation deletePrivateEndpointId +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivatenetworksettingendpointid. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation deletePrivateEndpointId [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 + * - --endpointId + - string + - true + - unique 22-character alphanumeric string that identifies the private endpoint to remove + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deletePrivateEndpointId + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt deleted file mode 100644 index 9825793197..0000000000 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs: - -=========================================================== -atlas api dataFederation downloadFederatedDatabaseQueryLogs -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Downloads the query logs for the specified federated database instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadfederateddatabasequerylogs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation downloadFederatedDatabaseQueryLogs [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 - * - --endDate - - int - - false - - Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - * - --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 downloadFederatedDatabaseQueryLogs - * - -o, --output - - string - - false - - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --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) - * - --startDate - - int - - false - - Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance for which you want to download query logs. - * - --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-dataFederation-downloadFederatedDatabaseQueryLogs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-downloadFederationQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederationQueryLogs.txt new file mode 100644 index 0000000000..541316ed77 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-downloadFederationQueryLogs.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-downloadFederationQueryLogs: + +==================================================== +atlas api dataFederation downloadFederationQueryLogs +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Downloads the query logs for the specified federated database instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupdatafederationquerylogs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation downloadFederationQueryLogs [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 + * - --endDate + - int + - false + - timestamp that specifies the end point for the range of log messages to download + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for downloadFederationQueryLogs + * - -o, --output + - string + - false + - preferred api format, can be ["gzip"] This value defaults to "gzip". + * - --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) + * - --startDate + - int + - false + - timestamp that specifies the starting point for the range of log messages to download + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance for which you want to download query logs + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-getDataFederation.txt b/docs/command/atlas-api-dataFederation-getDataFederation.txt new file mode 100644 index 0000000000..4577c41a02 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-getDataFederation.txt @@ -0,0 +1,91 @@ +.. _atlas-api-dataFederation-getDataFederation: + +========================================== +atlas api dataFederation getDataFederation +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of one federated database instance within the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatafederation. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation getDataFederation [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getDataFederation + * - -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) + * - --tenantName + - string + - true + - human-readable label that identifies the Federated Database to return + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-getDataFederationLimit.txt b/docs/command/atlas-api-dataFederation-getDataFederationLimit.txt new file mode 100644 index 0000000000..fcd2f58f79 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-getDataFederationLimit.txt @@ -0,0 +1,99 @@ +.. _atlas-api-dataFederation-getDataFederationLimit: + +=============================================== +atlas api dataFederation getDataFederationLimit +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of one query limit for the specified federated database instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatafederationlimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation getDataFederationLimit [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getDataFederationLimit + * - --limitName + - string + - true + - human-readable label that identifies this data federation instance limit + * - -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 + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance to which the query limit applies + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt deleted file mode 100644 index a9e21bf524..0000000000 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-getDataFederationPrivateEndpoint: - -========================================================= -atlas api dataFederation getDataFederationPrivateEndpoint -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatafederationprivateendpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation getDataFederationPrivateEndpoint [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 - * - --endpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. - * - --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 getDataFederationPrivateEndpoint - * - -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. - * - --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-dataFederation-getDataFederationPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt deleted file mode 100644 index 4657140506..0000000000 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-dataFederation-getFederatedDatabase: - -============================================= -atlas api dataFederation getFederatedDatabase -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of one federated database instance within the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederateddatabase. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation getFederatedDatabase [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 getFederatedDatabase - * - -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) - * - --tenantName - - string - - true - - Human-readable label that identifies the Federated Database to return. - * - --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-dataFederation-getFederatedDatabase-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-getPrivateEndpointId.txt b/docs/command/atlas-api-dataFederation-getPrivateEndpointId.txt new file mode 100644 index 0000000000..9c73814826 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-getPrivateEndpointId.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-getPrivateEndpointId: + +============================================= +atlas api dataFederation getPrivateEndpointId +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivatenetworksettingendpointid. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation getPrivateEndpointId [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 + * - --endpointId + - string + - true + - unique 22-character alphanumeric string that identifies the private endpoint to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getPrivateEndpointId + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-listDataFederation.txt b/docs/command/atlas-api-dataFederation-listDataFederation.txt new file mode 100644 index 0000000000..99d5961003 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-listDataFederation.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-listDataFederation: + +=========================================== +atlas api dataFederation listDataFederation +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of all federated database instances in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatafederation. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation listDataFederation [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listDataFederation + * - -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 + * - --type + - string + - false + - type of Federated Database Instances to return + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-listDataFederationLimits.txt b/docs/command/atlas-api-dataFederation-listDataFederationLimits.txt new file mode 100644 index 0000000000..cdf1beba7a --- /dev/null +++ b/docs/command/atlas-api-dataFederation-listDataFederationLimits.txt @@ -0,0 +1,95 @@ +.. _atlas-api-dataFederation-listDataFederationLimits: + +================================================= +atlas api dataFederation listDataFederationLimits +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns query limits for a federated databases instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatafederationlimits. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation listDataFederationLimits [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listDataFederationLimits + * - -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 + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance for which you want to retrieve query limits + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt deleted file mode 100644 index c84a895269..0000000000 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-dataFederation-listDataFederationPrivateEndpoints: - -=========================================================== -atlas api dataFederation listDataFederationPrivateEndpoints -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatafederationprivateendpoints. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation listDataFederationPrivateEndpoints [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 listDataFederationPrivateEndpoints - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-dataFederation-listDataFederationPrivateEndpoints-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt deleted file mode 100644 index b568b10941..0000000000 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-listFederatedDatabases: - -=============================================== -atlas api dataFederation listFederatedDatabases -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of all federated database instances in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederateddatabases. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation listFederatedDatabases [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 listFederatedDatabases - * - -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. - * - --type - - string - - false - - Type of Federated Database Instances to return. - * - --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-dataFederation-listFederatedDatabases-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-listPrivateEndpointIds.txt b/docs/command/atlas-api-dataFederation-listPrivateEndpointIds.txt new file mode 100644 index 0000000000..34b6d99e1a --- /dev/null +++ b/docs/command/atlas-api-dataFederation-listPrivateEndpointIds.txt @@ -0,0 +1,103 @@ +.. _atlas-api-dataFederation-listPrivateEndpointIds: + +=============================================== +atlas api dataFederation listPrivateEndpointIds +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivatenetworksettingendpointids. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation listPrivateEndpointIds [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listPrivateEndpointIds + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt deleted file mode 100644 index e248f1f93d..0000000000 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-dataFederation-returnFederatedDatabaseQueryLimit: - -========================================================== -atlas api dataFederation returnFederatedDatabaseQueryLimit -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of one query limit for the specified federated database instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation returnFederatedDatabaseQueryLimit [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 returnFederatedDatabaseQueryLimit - * - --limitName - - string - - true - - Human-readable label that identifies this data federation instance limit. - - | Limit Name | Description | Default | - | --- | --- | --- | - | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | - | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | - | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | - | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - - * - -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. - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance to which the query limit applies. - * - --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-dataFederation-returnFederatedDatabaseQueryLimit-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt deleted file mode 100644 index d4f708f623..0000000000 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-dataFederation-returnFederatedDatabaseQueryLimits: - -=========================================================== -atlas api dataFederation returnFederatedDatabaseQueryLimits -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns query limits for a federated databases instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimits. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation returnFederatedDatabaseQueryLimits [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 returnFederatedDatabaseQueryLimits - * - -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. - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance for which you want to retrieve query limits. - * - --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-dataFederation-returnFederatedDatabaseQueryLimits-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-dataFederation-setDataFederationLimit.txt b/docs/command/atlas-api-dataFederation-setDataFederationLimit.txt new file mode 100644 index 0000000000..8b89e1cd00 --- /dev/null +++ b/docs/command/atlas-api-dataFederation-setDataFederationLimit.txt @@ -0,0 +1,99 @@ +.. _atlas-api-dataFederation-setDataFederationLimit: + +=============================================== +atlas api dataFederation setDataFederationLimit +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates or updates one query limit for one federated database instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgroupdatafederationlimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation setDataFederationLimit [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for setDataFederationLimit + * - --limitName + - string + - true + - human-readable label that identifies this data federation instance limit + * - -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) + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance to which the query limit applies + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-updateDataFederation.txt b/docs/command/atlas-api-dataFederation-updateDataFederation.txt new file mode 100644 index 0000000000..fd8e8c19ac --- /dev/null +++ b/docs/command/atlas-api-dataFederation-updateDataFederation.txt @@ -0,0 +1,103 @@ +.. _atlas-api-dataFederation-updateDataFederation: + +============================================= +atlas api dataFederation updateDataFederation +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the details of one federated database instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupdatafederation. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api dataFederation updateDataFederation [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateDataFederation + * - -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 + * - --skipRoleValidation + - + - true + - flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket + * - --tenantName + - string + - true + - human-readable label that identifies the federated database instance to update + * - --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. + diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt deleted file mode 100644 index ba2812a205..0000000000 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-dataFederation-updateFederatedDatabase: - -================================================ -atlas api dataFederation updateFederatedDatabase -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the details of one federated database instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederateddatabase. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api dataFederation updateFederatedDatabase [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateFederatedDatabase - * - -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. - * - --skipRoleValidation - - - - true - - Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. - * - --tenantName - - string - - true - - Human-readable label that identifies the federated database instance to update. - * - --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. - diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index e80491101f..17d1a1fb51 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -54,37 +54,37 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederation` - Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createPrivateEndpointId` - Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-deleteDataFederation` - Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteDataFederationLimit` - Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deletePrivateEndpointId` - Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-downloadFederationQueryLogs` - Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederation` - Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-getDataFederationLimit` - Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-getPrivateEndpointId` - Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listDataFederation` - Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationLimits` - Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-listPrivateEndpointIds` - Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-setDataFederationLimit` - Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-updateDataFederation` - Updates the details of one federated database instance in the specified project. .. toctree:: :titlesonly: - createDataFederationPrivateEndpoint - createFederatedDatabase - createOneDataFederationQueryLimit - deleteDataFederationPrivateEndpoint - deleteFederatedDatabase - deleteOneDataFederationInstanceQueryLimit - downloadFederatedDatabaseQueryLogs - getDataFederationPrivateEndpoint - getFederatedDatabase - listDataFederationPrivateEndpoints - listFederatedDatabases - returnFederatedDatabaseQueryLimit - returnFederatedDatabaseQueryLimits - updateFederatedDatabase + createDataFederation + createPrivateEndpointId + deleteDataFederation + deleteDataFederationLimit + deletePrivateEndpointId + downloadFederationQueryLogs + getDataFederation + getDataFederationLimit + getPrivateEndpointId + listDataFederation + listDataFederationLimits + listPrivateEndpointIds + setDataFederationLimit + updateDataFederation diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index 6c86460a84..9f876911d9 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatabaseuser. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,86 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. tabs:: - - .. tab:: Example - :tabid: 2023-01-01_aws_iam_authentication - - AWS IAM Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication.sh - :language: shell - .. tab:: Example 1 - :tabid: 2023-01-01_ldap_authentication - - LDAP Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication.sh - :language: shell - .. tab:: Example 2 - :tabid: 2023-01-01_oidc_workforce_federated_authentication - - OIDC Workforce Federated Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication.sh - :language: shell - .. tab:: Example 3 - :tabid: 2023-01-01_oidc_workload_federated_authentication - - OIDC Workload Federated Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication.sh - :language: shell - .. tab:: Example 4 - :tabid: 2023-01-01_scram-sha_authentication - - SCRAM-SHA Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication.sh - :language: shell - .. tab:: Example 5 - :tabid: 2023-01-01_x509_authentication - - X509 Authentication - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication.sh - :language: shell diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index 7f04bd8004..834429679d 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatabaseuser. For more information and examples, see the referenced API documentation linked above. @@ -45,19 +45,17 @@ Options - Required - Description * - --databaseName - - $external + - string - true - - The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`. + - the database against which the database user authenticates * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,24 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --username - string - true - - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: - - | Authentication Method | Parameter Needed | Parameter Value | username Format | - - | AWS IAM | awsIAMType | ROLE | ARN | - | AWS IAM | awsIAMType | USER | ARN | - | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | - | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | - | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | - + - human-readable label that represents the user that authenticates to MongoDB * - --version - string - false @@ -112,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-databaseUsers-deleteDatabaseUser-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index 9211e0cbde..d360d34f86 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatabaseuser. For more information and examples, see the referenced API documentation linked above. @@ -45,19 +45,17 @@ Options - Required - Description * - --databaseName - - $external + - string - true - - The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`. + - the database against which the database user authenticates * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,24 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --username - string - true - - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: - - | Authentication Method | Parameter Needed | Parameter Value | username Format | - - | AWS IAM | awsIAMType | ROLE | ARN | - | AWS IAM | awsIAMType | USER | ARN | - | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | - | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | - | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | - + - human-readable label that represents the user that authenticates to MongoDB * - --version - string - false @@ -112,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-databaseUsers-getDatabaseUser-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index 42735ce488..c761fdca7c 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatabaseusers. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,11 +59,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -77,11 +75,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-databaseUsers-listDatabaseUsers-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index e23f8bf25d..194012b0c2 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupdatabaseuser. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - Required - Description * - --databaseName - - $external + - string - true - - The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`. + - the database against which the database user authenticates * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,24 +75,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --username - string - true - - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: - - | Authentication Method | Parameter Needed | Parameter Value | username Format | - - | AWS IAM | awsIAMType | ROLE | ARN | - | AWS IAM | awsIAMType | USER | ARN | - | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | - | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | - | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | - | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | - + - human-readable label that represents the user that authenticates to MongoDB * - --version - string - false diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt deleted file mode 100644 index 862f924526..0000000000 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint: - -========================================================================================== -atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPrivateEndpoint -========================================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a private endpoint in the specified region for encryption at rest using customer key management. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createencryptionatrestprivateendpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPrivateEndpoint [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 - * - --cloudProvider - - string - - true - - Human-readable label that identifies the cloud provider for the private endpoint to create. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createEncryptionAtRestPrivateEndpoint - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createRestPrivateEndpoint.txt new file mode 100644 index 0000000000..7ad651f472 --- /dev/null +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createRestPrivateEndpoint.txt @@ -0,0 +1,97 @@ +.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-createRestPrivateEndpoint: + +============================================================================== +atlas api encryptionAtRestUsingCustomerKeyManagement createRestPrivateEndpoint +============================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a private endpoint in the specified region for encryption at rest using customer key management. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-creategroupencryptionatrestprivateendpoint. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api encryptionAtRestUsingCustomerKeyManagement createRestPrivateEndpoint [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 + * - --cloudProvider + - string + - true + - human-readable label that identifies the cloud provider for the private endpoint to create + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createRestPrivateEndpoint + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 2de42f11ea..524b914cb9 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -22,7 +22,7 @@ MongoDB Cloud encrypts all storage even if you don't use your own key management LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrest. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupencryptionatrest. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -72,7 +70,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -94,8 +92,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt deleted file mode 100644 index 87b4960cfe..0000000000 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint: - -======================================================================================= -atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint -======================================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint [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 - * - --cloudProvider - - string - - true - - Human-readable label that identifies the cloud provider of the private endpoint. - * - --endpointId - - string - - true - - Unique 24-hexadecimal digit string that identifies the private endpoint. - * - --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 getEncryptionAtRestPrivateEndpoint - * - -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. - * - --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-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt deleted file mode 100644 index 0df51d9fba..0000000000 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider: - -======================================================================================================== -atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider -======================================================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpointsforcloudprovider. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider [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 - * - --cloudProvider - - string - - true - - Human-readable label that identifies the cloud provider for the private endpoints to return. - * - --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 getEncryptionAtRestPrivateEndpointsForCloudProvider - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getRestPrivateEndpoint.txt new file mode 100644 index 0000000000..52378fe7d3 --- /dev/null +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getRestPrivateEndpoint.txt @@ -0,0 +1,97 @@ +.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-getRestPrivateEndpoint: + +=========================================================================== +atlas api encryptionAtRestUsingCustomerKeyManagement getRestPrivateEndpoint +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupencryptionatrestprivateendpoint. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api encryptionAtRestUsingCustomerKeyManagement getRestPrivateEndpoint [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 + * - --cloudProvider + - string + - true + - human-readable label that identifies the cloud provider of the private endpoint + * - --endpointId + - string + - true + - unique 24-hexadecimal digit string that identifies the private endpoint + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getRestPrivateEndpoint + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-listRestPrivateEndpoints.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-listRestPrivateEndpoints.txt new file mode 100644 index 0000000000..16b68a8cbe --- /dev/null +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-listRestPrivateEndpoints.txt @@ -0,0 +1,105 @@ +.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-listRestPrivateEndpoints: + +============================================================================= +atlas api encryptionAtRestUsingCustomerKeyManagement listRestPrivateEndpoints +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupencryptionatrestprivateendpoints. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api encryptionAtRestUsingCustomerKeyManagement listRestPrivateEndpoints [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 + * - --cloudProvider + - string + - true + - human-readable label that identifies the cloud provider for the private endpoints to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listRestPrivateEndpoints + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt deleted file mode 100644 index d20e0ac36c..0000000000 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion: - -=================================================================================================== -atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion -=================================================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-requestencryptionatrestprivateendpointdeletion. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion [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 - * - --cloudProvider - - string - - true - - Human-readable label that identifies the cloud provider of the private endpoint to delete. - * - --endpointId - - string - - true - - Unique 24-hexadecimal digit string that identifies the private endpoint to delete. - * - --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 requestEncryptionAtRestPrivateEndpointDeletion - * - -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. - * - --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-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestPrivateEndpointDeletion.txt new file mode 100644 index 0000000000..f0e51ca3d5 --- /dev/null +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestPrivateEndpointDeletion.txt @@ -0,0 +1,97 @@ +.. _atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestPrivateEndpointDeletion: + +=================================================================================== +atlas api encryptionAtRestUsingCustomerKeyManagement requestPrivateEndpointDeletion +=================================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-requestgroupencryptionatrestprivateendpointdeletion. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api encryptionAtRestUsingCustomerKeyManagement requestPrivateEndpointDeletion [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 + * - --cloudProvider + - string + - true + - human-readable label that identifies the cloud provider of the private endpoint to delete + * - --endpointId + - string + - true + - unique 24-hexadecimal digit string that identifies the private endpoint to delete + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for requestPrivateEndpointDeletion + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 9361f13623..8695a927e2 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -22,7 +22,7 @@ MongoDB Cloud encrypts all storage even if you don't use your own key management After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateencryptionatrest. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupencryptionatrest. For more information and examples, see the referenced API documentation linked above. @@ -48,9 +48,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -58,9 +58,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index 2f1af2128c..f9e6c17fca 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -54,21 +54,21 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createRestPrivateEndpoint` - Creates a private endpoint in the specified region for encryption at rest using customer key management. * :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getRestPrivateEndpoint` - Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-listRestPrivateEndpoints` - Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestPrivateEndpointDeletion` - Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. * :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - Updates the configuration for encryption at rest using the keys you manage through your cloud provider. .. toctree:: :titlesonly: - createEncryptionAtRestPrivateEndpoint + createRestPrivateEndpoint getEncryptionAtRest - getEncryptionAtRestPrivateEndpoint - getEncryptionAtRestPrivateEndpointsForCloudProvider - requestEncryptionAtRestPrivateEndpointDeletion + getRestPrivateEndpoint + listRestPrivateEndpoints + requestPrivateEndpointDeletion updateEncryptionAtRest diff --git a/docs/command/atlas-api-events-getGroupEvent.txt b/docs/command/atlas-api-events-getGroupEvent.txt new file mode 100644 index 0000000000..5ffaee17dd --- /dev/null +++ b/docs/command/atlas-api-events-getGroupEvent.txt @@ -0,0 +1,109 @@ +.. _atlas-api-events-getGroupEvent: + +============================== +atlas api events getGroupEvent +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one event for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupevent. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api events getGroupEvent [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. + * - --eventId + - string + - true + - Unique 24-hexadecimal digit string that identifies the event that you want to return. + * - --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 getGroupEvent + * - --includeRaw + - + - false + - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. + * - -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. + * - --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-events-getGroupEvent-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-events-getOrgEvent.txt b/docs/command/atlas-api-events-getOrgEvent.txt new file mode 100644 index 0000000000..ba9bb24c9e --- /dev/null +++ b/docs/command/atlas-api-events-getOrgEvent.txt @@ -0,0 +1,107 @@ +.. _atlas-api-events-getOrgEvent: + +============================ +atlas api events getOrgEvent +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one event for the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgevent. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api events getOrgEvent [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. + * - --eventId + - string + - true + - Unique 24-hexadecimal digit string that identifies the event that you want to return. + * - -h, --help + - + - false + - help for getOrgEvent + * - --includeRaw + - + - false + - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-events-getOrgEvent-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt deleted file mode 100644 index 4a5bd2c918..0000000000 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-events-getOrganizationEvent: - -===================================== -atlas api events getOrganizationEvent -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one event for the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationevent. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api events getOrganizationEvent [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. - * - --eventId - - string - - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. - * - -h, --help - - - - false - - help for getOrganizationEvent - * - --includeRaw - - - - false - - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-events-getOrganizationEvent-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt deleted file mode 100644 index ad82105976..0000000000 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-events-getProjectEvent: - -================================ -atlas api events getProjectEvent -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one event for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectevent. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api events getProjectEvent [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. - * - --eventId - - string - - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. - * - --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 getProjectEvent - * - --includeRaw - - - - false - - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. - * - -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. - * - --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-events-getProjectEvent-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-events-listGroupEvents.txt b/docs/command/atlas-api-events-listGroupEvents.txt new file mode 100644 index 0000000000..5cc5d9f668 --- /dev/null +++ b/docs/command/atlas-api-events-listGroupEvents.txt @@ -0,0 +1,141 @@ +.. _atlas-api-events-listGroupEvents: + +================================ +atlas api events listGroupEvents +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns events for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupevents. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api events listGroupEvents [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 + * - --clusterNames + - stringArray + - false + - 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. + * - --eventType + - stringArray + - false + - Category of incident recorded at this moment in time. + + **IMPORTANT**: The complete list of event type values changes frequently. + * - --excludedEventType + - stringArray + - false + - Category of event that you would like to exclude from query results, such as CLUSTER_CREATED + + **IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types. + * - --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 listGroupEvents + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --includeRaw + - + - false + - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --maxDate + - string + - false + - Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. + * - --minDate + - string + - false + - Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-events-listGroupEvents-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-events-listOrgEvents.txt b/docs/command/atlas-api-events-listOrgEvents.txt new file mode 100644 index 0000000000..2e81808a5f --- /dev/null +++ b/docs/command/atlas-api-events-listOrgEvents.txt @@ -0,0 +1,129 @@ +.. _atlas-api-events-listOrgEvents: + +============================== +atlas api events listOrgEvents +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns events for the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + + +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgevents. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api events listOrgEvents [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. + * - --eventType + - stringArray + - false + - Category of incident recorded at this moment in time. + + **IMPORTANT**: The complete list of event type values changes frequently. + * - -h, --help + - + - false + - help for listOrgEvents + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --includeRaw + - + - false + - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --maxDate + - string + - false + - Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. + * - --minDate + - string + - false + - Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. + * - --orgId + - string + - true + - 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. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-events-listOrgEvents-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt deleted file mode 100644 index f8d812fd28..0000000000 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ /dev/null @@ -1,129 +0,0 @@ -.. _atlas-api-events-listOrganizationEvents: - -======================================= -atlas api events listOrganizationEvents -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns events for the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationevents. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api events listOrganizationEvents [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. - * - --eventType - - stringArray - - false - - Category of incident recorded at this moment in time. - - **IMPORTANT**: The complete list of event type values changes frequently. - * - -h, --help - - - - false - - help for listOrganizationEvents - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --includeRaw - - - - false - - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --maxDate - - string - - false - - Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. - * - --minDate - - string - - false - - Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-events-listOrganizationEvents-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt deleted file mode 100644 index 9ce04e353a..0000000000 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ /dev/null @@ -1,141 +0,0 @@ -.. _atlas-api-events-listProjectEvents: - -================================== -atlas api events listProjectEvents -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns events for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This resource remains under revision and may change. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectevents. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api events listProjectEvents [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 - * - --clusterNames - - stringArray - - false - - 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. - * - --eventType - - stringArray - - false - - Category of incident recorded at this moment in time. - - **IMPORTANT**: The complete list of event type values changes frequently. - * - --excludedEventType - - stringArray - - false - - Category of event that you would like to exclude from query results, such as CLUSTER_CREATED - - **IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types. - * - --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 listProjectEvents - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --includeRaw - - - - false - - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --maxDate - - string - - false - - Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. - * - --minDate - - string - - false - - Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-events-listProjectEvents-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index 7bedd4eed2..5d0e09f8ea 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -54,19 +54,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - Returns one event for the specified project. +* :ref:`atlas-api-events-getGroupEvent` - Returns one event for the specified project. +* :ref:`atlas-api-events-getOrgEvent` - Returns one event for the specified organization. * :ref:`atlas-api-events-listEventTypes` - Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - Returns events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - Returns events for the specified project. +* :ref:`atlas-api-events-listGroupEvents` - Returns events for the specified project. +* :ref:`atlas-api-events-listOrgEvents` - Returns events for the specified organization. .. toctree:: :titlesonly: - getOrganizationEvent - getProjectEvent + getGroupEvent + getOrgEvent listEventTypes - listOrganizationEvents - listProjectEvents + listGroupEvents + listOrgEvents diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index fe0e39a5a7..9e74276a80 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Or Note: This resource only supports the creation of OIDC identity providers. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederationsettingidentityprovider. For more information and examples, see the referenced API documentation linked above. @@ -48,13 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - --file - string - false diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index f34a53a6b2..5359985642 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederationsettingconnectedorgconfigrolemapping. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - --file - string - false @@ -63,7 +63,7 @@ Options * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt deleted file mode 100644 index 859a9e2283..0000000000 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _atlas-api-federatedAuthentication-deleteFederationApp: - -===================================================== -atlas api federatedAuthentication deleteFederationApp -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes the federation settings instance and all associated data, including identity providers and domains. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationapp. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api federatedAuthentication deleteFederationApp [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 - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies your federation. - * - -h, --help - - - - false - - help for deleteFederationApp - * - -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) - * - --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-federatedAuthentication-deleteFederationApp-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationSetting.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationSetting.txt new file mode 100644 index 0000000000..01129135d3 --- /dev/null +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationSetting.txt @@ -0,0 +1,88 @@ +.. _atlas-api-federatedAuthentication-deleteFederationSetting: + +========================================================= +atlas api federatedAuthentication deleteFederationSetting +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes the federation settings instance and all associated data, including identity providers and domains. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsetting. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api federatedAuthentication deleteFederationSetting [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 + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies your federation. + * - -h, --help + - + - false + - help for deleteFederationSetting + * - -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) + * - --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-federatedAuthentication-deleteFederationSetting-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index ae52b2678a..bb85b7ce85 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Or Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsettingidentityprovider. For more information and examples, see the referenced API documentation linked above. @@ -48,13 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -62,7 +62,7 @@ Options * - --identityProviderId - string - true - - Unique 24-hexadecimal digit string that identifies the identity provider to connect. + - unique 24-hexadecimal digit string that identifies the identity provider to connect * - -o, --output - string - false @@ -92,8 +92,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-deleteIdentityProvider-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index a4f54408f6..d97f19bef5 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleterolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsettingconnectedorgconfigrolemapping. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,11 +59,11 @@ Options * - --id - string - true - - Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. + - unique 24-hexadecimal digit string that identifies the role mapping that you want to remove * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -93,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-deleteRoleMapping-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index 75e3c3b887..93b08b7e67 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingconnectedorgconfig. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,7 +59,7 @@ Options * - --orgId - string - true - - Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. + - unique 24-hexadecimal digit string that identifies the connected organization configuration to return * - -o, --output - string - false @@ -89,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-getConnectedOrgConfig-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index c66e751735..01d30b54fd 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgfederationsettings. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - -h, --help - - false @@ -55,7 +55,7 @@ Options * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -67,7 +67,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -89,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-getFederationSettings-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index bef7adb763..30a983a8ca 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingidentityprovider. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,7 +59,7 @@ Options * - --identityProviderId - string - true - - Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. + - unique string that identifies the identity provider to connect * - -o, --output - string - false @@ -89,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-getIdentityProvider-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index c65a84ea21..0f3de94524 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovidermetadata. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingidentityprovidermetadata. For more information and examples, see the referenced API documentation linked above. @@ -47,7 +47,7 @@ Options * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -55,7 +55,7 @@ Options * - --identityProviderId - string - true - - Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. + - legacy 20-hexadecimal digit string that identifies the identity provider * - -o, --output - string - false @@ -85,8 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-getIdentityProviderMetadata-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index a5521eeb2a..6d19f92665 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getrolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingconnectedorgconfigrolemapping. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,11 +59,11 @@ Options * - --id - string - true - - Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. + - unique 24-hexadecimal digit string that identifies the role mapping that you want to return * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -93,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-getRoleMapping-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index e957ecdb53..68093fe8f2 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listconnectedorgconfigs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingconnectedorgconfigs. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,7 +59,7 @@ Options * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -71,7 +71,7 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --version - string - false @@ -93,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-listConnectedOrgConfigs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 23b4a7d303..b52232ae00 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listidentityproviders. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingidentityproviders. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,11 +59,11 @@ Options * - --idpType - stringArray - false - - The types of the target identity providers. + - the types of the target identity providers * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -75,11 +75,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --protocol - stringArray - false - - The protocols of the target identity providers. + - the protocols of the target identity providers * - --version - string - false @@ -101,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-listIdentityProviders-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index e8d244a16d..1137a7f53b 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listrolemappings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingconnectedorgconfigrolemappings. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,7 +59,7 @@ Options * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -89,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-listRoleMappings-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 5949703771..a1ad4afba2 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removefederationsettingconnectedorgconfig. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - -h, --help - - false @@ -59,7 +59,7 @@ Options * - --orgId - string - true - - Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. + - unique 24-hexadecimal digit string that identifies the connected organization configuration to remove * - -o, --output - string - false @@ -89,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-federatedAuthentication-removeConnectedOrgConfig-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-revokeIdentityProviderJwks.txt b/docs/command/atlas-api-federatedAuthentication-revokeIdentityProviderJwks.txt new file mode 100644 index 0000000000..a411729589 --- /dev/null +++ b/docs/command/atlas-api-federatedAuthentication-revokeIdentityProviderJwks.txt @@ -0,0 +1,94 @@ +.. _atlas-api-federatedAuthentication-revokeIdentityProviderJwks: + +============================================================ +atlas api federatedAuthentication revokeIdentityProviderJwks +============================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Revokes the JWKS tokens from the requested OIDC identity provider. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. + + +Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokefederationsettingidentityproviderjwks. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api federatedAuthentication revokeIdentityProviderJwks [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --federationSettingsId + - string + - true + - unique 24-hexadecimal digit string that identifies your federation + * - -h, --help + - + - false + - help for revokeIdentityProviderJwks + * - --identityProviderId + - string + - true + - unique 24-hexadecimal digit string that identifies the identity provider to connect + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt deleted file mode 100644 index 4d3a90815b..0000000000 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider: - -================================================================ -atlas api federatedAuthentication revokeJwksFromIdentityProvider -================================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Revokes the JWKS tokens from the requested OIDC identity provider. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - - -Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokejwksfromidentityprovider. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api federatedAuthentication revokeJwksFromIdentityProvider [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. - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies your federation. - * - -h, --help - - - - false - - help for revokeJwksFromIdentityProvider - * - --identityProviderId - - string - - true - - Unique 24-hexadecimal digit string that identifies the identity provider to connect. - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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-federatedAuthentication-revokeJwksFromIdentityProvider-2023-11-15-default.sh - :language: shell diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 7fc8250e0f..93b25b7211 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -31,7 +31,7 @@ Note: If the identityProviderId field is not provided, you will disconnect the o Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfig. For more information and examples, see the referenced API documentation linked above. @@ -57,13 +57,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - --file - string - false @@ -75,7 +75,7 @@ Options * - --orgId - string - true - - Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. + - unique 24-hexadecimal digit string that identifies the connected organization configuration to update * - -o, --output - string - false diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 30c0998433..68283b0800 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Or Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingidentityprovider. For more information and examples, see the referenced API documentation linked above. @@ -48,13 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - --file - string - false @@ -66,7 +66,7 @@ Options * - --identityProviderId - string - true - - Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. + - unique string that identifies the identity provider to connect * - -o, --output - string - false diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 1912387ea3..b801084253 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updaterolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfigrolemapping. For more information and examples, see the referenced API documentation linked above. @@ -45,13 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --federationSettingsId - string - true - - Unique 24-hexadecimal digit string that identifies your federation. + - unique 24-hexadecimal digit string that identifies your federation * - --file - string - false @@ -63,11 +63,11 @@ Options * - --id - string - true - - Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. + - unique 24-hexadecimal digit string that identifies the role mapping that you want to update * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index f2addd0a39..405ea2510d 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -56,7 +56,7 @@ Related Commands * :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - Creates one identity provider within the specified federation. * :ref:`atlas-api-federatedAuthentication-createRoleMapping` - Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteFederationSetting` - Deletes the federation settings instance and all associated data, including identity providers and domains. * :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - Deletes one identity provider in the specified federation. * :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - Removes one role mapping in the specified organization from the specified federation. * :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - Returns the specified connected org config from the specified federation. @@ -68,7 +68,7 @@ Related Commands * :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - Returns all identity providers with the provided protocol and type in the specified federation. * :ref:`atlas-api-federatedAuthentication-listRoleMappings` - Returns all role mappings from the specified organization in the specified federation. * :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-revokeIdentityProviderJwks` - Revokes the JWKS tokens from the requested OIDC identity provider. * :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - Updates one connected organization configuration from the specified federation. * :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - Updates one identity provider in the specified federation. * :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - Updates one role mapping in the specified organization in the specified federation. @@ -79,7 +79,7 @@ Related Commands createIdentityProvider createRoleMapping - deleteFederationApp + deleteFederationSetting deleteIdentityProvider deleteRoleMapping getConnectedOrgConfig @@ -91,7 +91,7 @@ Related Commands listIdentityProviders listRoleMappings removeConnectedOrgConfig - revokeJwksFromIdentityProvider + revokeIdentityProviderJwks updateConnectedOrgConfig updateIdentityProvider updateRoleMapping diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index 0f93a76df0..b00870040c 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupflexcluster. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 2fd95d5a93..cc3fb4639f 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupflexcluster. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,7 +59,7 @@ Options * - --name - string - true - - Human-readable label that identifies the flex cluster. + - human-readable label that identifies the flex cluster * - -o, --output - string - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-flexClusters-deleteFlexCluster-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 2e16283e28..465e4afe24 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexcluster. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,7 +59,7 @@ Options * - --name - string - true - - Human-readable label that identifies the flex cluster. + - human-readable label that identifies the flex cluster * - -o, --output - string - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-flexClusters-getFlexCluster-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index f145910132..94f67e0350 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexclusters. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusters. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,11 +59,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -77,11 +75,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-flexClusters-listFlexClusters-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexClusters-tenantUpgrade.txt b/docs/command/atlas-api-flexClusters-tenantUpgrade.txt new file mode 100644 index 0000000000..e8d96e46ac --- /dev/null +++ b/docs/command/atlas-api-flexClusters-tenantUpgrade.txt @@ -0,0 +1,95 @@ +.. _atlas-api-flexClusters-tenantUpgrade: + +==================================== +atlas api flexClusters tenantUpgrade +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-tenantgroupflexclusterupgrade. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexClusters tenantUpgrade [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for tenantUpgrade + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 51d04e404c..71641d953e 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupflexcluster. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -65,7 +63,7 @@ Options * - --name - string - true - - Human-readable label that identifies the flex cluster. + - human-readable label that identifies the flex cluster * - -o, --output - string - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt deleted file mode 100644 index 99bbfbf3f3..0000000000 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-flexClusters-upgradeFlexCluster: - -========================================= -atlas api flexClusters upgradeFlexCluster -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradeflexcluster. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexClusters upgradeFlexCluster [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 upgradeFlexCluster - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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. - diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 2f757808ee..cf8382175b 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -58,8 +58,8 @@ Related Commands * :ref:`atlas-api-flexClusters-deleteFlexCluster` - Removes one flex cluster from the specified project. * :ref:`atlas-api-flexClusters-getFlexCluster` - Returns details for one flex cluster in the specified project. * :ref:`atlas-api-flexClusters-listFlexClusters` - Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-tenantUpgrade` - Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. * :ref:`atlas-api-flexClusters-updateFlexCluster` - Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. .. toctree:: @@ -69,6 +69,6 @@ Related Commands deleteFlexCluster getFlexCluster listFlexClusters + tenantUpgrade updateFlexCluster - upgradeFlexCluster diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt deleted file mode 100644 index bc2c6d7255..0000000000 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-flexRestoreJobs-createFlexBackupRestoreJob: - -==================================================== -atlas api flexRestoreJobs createFlexBackupRestoreJob -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restores one snapshot of one flex cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexRestoreJobs createFlexBackupRestoreJob [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createFlexBackupRestoreJob - * - --name - - string - - true - - Human-readable label that identifies the flex cluster whose snapshot you want to restore. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexRestoreJob.txt new file mode 100644 index 0000000000..096c585699 --- /dev/null +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexRestoreJob.txt @@ -0,0 +1,107 @@ +.. _atlas-api-flexRestoreJobs-createFlexRestoreJob: + +============================================== +atlas api flexRestoreJobs createFlexRestoreJob +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Restores one snapshot of one flex cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupflexclusterbackuprestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexRestoreJobs createFlexRestoreJob [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createFlexRestoreJob + * - --name + - string + - true + - human-readable label that identifies the flex cluster whose snapshot you want to restore + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt deleted file mode 100644 index 6921f0a318..0000000000 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-flexRestoreJobs-getFlexBackupRestoreJob: - -================================================= -atlas api flexRestoreJobs getFlexBackupRestoreJob -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one restore job for one flex cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexRestoreJobs getFlexBackupRestoreJob [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 getFlexBackupRestoreJob - * - --name - - string - - true - - Human-readable label that identifies the flex cluster. - * - -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. - * - --restoreJobId - - string - - true - - Unique 24-hexadecimal digit string that identifies the restore job to return. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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-flexRestoreJobs-getFlexBackupRestoreJob-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexRestoreJob.txt new file mode 100644 index 0000000000..989677a820 --- /dev/null +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexRestoreJob.txt @@ -0,0 +1,99 @@ +.. _atlas-api-flexRestoreJobs-getFlexRestoreJob: + +=========================================== +atlas api flexRestoreJobs getFlexRestoreJob +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one restore job for one flex cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexclusterbackuprestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexRestoreJobs getFlexRestoreJob [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getFlexRestoreJob + * - --name + - string + - true + - human-readable label that identifies the flex cluster + * - -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 + * - --restoreJobId + - string + - true + - unique 24-hexadecimal digit string that identifies the restore job to return + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt deleted file mode 100644 index 565c9c507d..0000000000 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs: - -=================================================== -atlas api flexRestoreJobs listFlexBackupRestoreJobs -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all restore jobs for one flex cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackuprestorejobs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexRestoreJobs listFlexBackupRestoreJobs [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 listFlexBackupRestoreJobs - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --name - - string - - true - - Human-readable label that identifies the flex cluster. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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-flexRestoreJobs-listFlexBackupRestoreJobs-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexRestoreJobs.txt new file mode 100644 index 0000000000..f87896117a --- /dev/null +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexRestoreJobs.txt @@ -0,0 +1,107 @@ +.. _atlas-api-flexRestoreJobs-listFlexRestoreJobs: + +============================================= +atlas api flexRestoreJobs listFlexRestoreJobs +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all restore jobs for one flex cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusterbackuprestorejobs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexRestoreJobs listFlexRestoreJobs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listFlexRestoreJobs + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --name + - string + - true + - human-readable label that identifies the flex cluster + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 6875fe52d2..b4d5ed1c84 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -54,15 +54,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexRestoreJob` - Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexRestoreJob` - Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexRestoreJobs` - Returns all restore jobs for one flex cluster from the specified project. .. toctree:: :titlesonly: - createFlexBackupRestoreJob - getFlexBackupRestoreJob - listFlexBackupRestoreJobs + createFlexRestoreJob + getFlexRestoreJob + listFlexRestoreJobs diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index b6ead9f0cb..743ed6cd48 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadflexbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupflexclusterbackup. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -65,7 +63,7 @@ Options * - --name - string - true - - Human-readable label that identifies the flex cluster. + - human-readable label that identifies the flex cluster * - -o, --output - string - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt deleted file mode 100644 index e967c19453..0000000000 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-flexSnapshots-getFlexBackup: - -===================================== -atlas api flexSnapshots getFlexBackup -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one snapshot of one flex cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexSnapshots getFlexBackup [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 getFlexBackup - * - --name - - string - - true - - Human-readable label that identifies the flex cluster. - * - -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) - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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-flexSnapshots-getFlexBackup-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackupSnapshot.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackupSnapshot.txt new file mode 100644 index 0000000000..bcee459920 --- /dev/null +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackupSnapshot.txt @@ -0,0 +1,95 @@ +.. _atlas-api-flexSnapshots-getFlexBackupSnapshot: + +============================================= +atlas api flexSnapshots getFlexBackupSnapshot +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one snapshot of one flex cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexclusterbackupsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexSnapshots getFlexBackupSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getFlexBackupSnapshot + * - --name + - string + - true + - human-readable label that identifies the flex cluster + * - -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) + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackupSnapshots.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackupSnapshots.txt new file mode 100644 index 0000000000..ccac53966f --- /dev/null +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackupSnapshots.txt @@ -0,0 +1,107 @@ +.. _atlas-api-flexSnapshots-listFlexBackupSnapshots: + +=============================================== +atlas api flexSnapshots listFlexBackupSnapshots +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all snapshots of one flex cluster from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusterbackupsnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api flexSnapshots listFlexBackupSnapshots [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listFlexBackupSnapshots + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --name + - string + - true + - human-readable label that identifies the flex cluster + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt deleted file mode 100644 index 5e69889fda..0000000000 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-flexSnapshots-listFlexBackups: - -======================================= -atlas api flexSnapshots listFlexBackups -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all snapshots of one flex cluster from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackups. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api flexSnapshots listFlexBackups [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 listFlexBackups - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --name - - string - - true - - Human-readable label that identifies the flex cluster. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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-flexSnapshots-listFlexBackups-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 0fe0bda4d7..1bf503f1d8 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -55,14 +55,14 @@ Related Commands ---------------- * :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-getFlexBackupSnapshot` - Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackupSnapshots` - Returns all snapshots of one flex cluster from the specified project. .. toctree:: :titlesonly: downloadFlexBackup - getFlexBackup - listFlexBackups + getFlexBackupSnapshot + listFlexBackupSnapshots diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 49a0f3ef66..83b1077236 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomzonemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterglobalwritecustomzonemapping. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 2a09c7111d..e8e09f51fd 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createmanagednamespace. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterglobalwritemanagednamespace. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies this cluster. + - human-readable label that identifies this 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt deleted file mode 100644 index 206c17bb3c..0000000000 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-globalClusters-deleteAllCustomZoneMappings: - -==================================================== -atlas api globalClusters deleteAllCustomZoneMappings -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes all custom zone mappings for the specified global cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallcustomzonemappings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api globalClusters deleteAllCustomZoneMappings [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 this 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 deleteAllCustomZoneMappings - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-globalClusters-deleteAllCustomZoneMappings-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-globalClusters-deleteCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-deleteCustomZoneMapping.txt new file mode 100644 index 0000000000..66f9e88b12 --- /dev/null +++ b/docs/command/atlas-api-globalClusters-deleteCustomZoneMapping.txt @@ -0,0 +1,95 @@ +.. _atlas-api-globalClusters-deleteCustomZoneMapping: + +================================================ +atlas api globalClusters deleteCustomZoneMapping +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes all custom zone mappings for the specified global cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterglobalwritecustomzonemapping. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api globalClusters deleteCustomZoneMapping [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 this cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteCustomZoneMapping + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt deleted file mode 100644 index dcd4a92f55..0000000000 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-globalClusters-deleteManagedNamespace: - -=============================================== -atlas api globalClusters deleteManagedNamespace -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one managed namespace within the specified global cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletemanagednamespace. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api globalClusters deleteManagedNamespace [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 this cluster. - * - --collection - - string - - false - - Human-readable label that identifies the collection associated with the managed namespace. - * - --db - - string - - false - - Human-readable label that identifies the database that contains the collection. - * - --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 deleteManagedNamespace - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-globalClusters-deleteManagedNamespace-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespaces.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespaces.txt new file mode 100644 index 0000000000..ca5c539788 --- /dev/null +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespaces.txt @@ -0,0 +1,103 @@ +.. _atlas-api-globalClusters-deleteManagedNamespaces: + +================================================ +atlas api globalClusters deleteManagedNamespaces +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one managed namespace within the specified global cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterglobalwritemanagednamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api globalClusters deleteManagedNamespaces [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 this cluster + * - --collection + - string + - false + - human-readable label that identifies the collection associated with the managed namespace + * - --db + - string + - false + - human-readable label that identifies the database that contains the collection + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteManagedNamespaces + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-globalClusters-getClusterGlobalWrites.txt b/docs/command/atlas-api-globalClusters-getClusterGlobalWrites.txt new file mode 100644 index 0000000000..71fe6011e0 --- /dev/null +++ b/docs/command/atlas-api-globalClusters-getClusterGlobalWrites.txt @@ -0,0 +1,95 @@ +.. _atlas-api-globalClusters-getClusterGlobalWrites: + +=============================================== +atlas api globalClusters getClusterGlobalWrites +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one managed namespace within the specified global cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterglobalwrites. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api globalClusters getClusterGlobalWrites [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 this cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterGlobalWrites + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt deleted file mode 100644 index 57fcb50eca..0000000000 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-globalClusters-getManagedNamespace: - -============================================ -atlas api globalClusters getManagedNamespace -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one managed namespace within the specified global cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmanagednamespace. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api globalClusters getManagedNamespace [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 this 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 getManagedNamespace - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-globalClusters-getManagedNamespace-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 950f60d268..aded51eb37 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -57,9 +57,9 @@ Related Commands * :ref:`atlas-api-globalClusters-createCustomZoneMapping` - Creates one custom zone mapping for the specified global cluster. * :ref:`atlas-api-globalClusters-createManagedNamespace` - Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteCustomZoneMapping` - Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespaces` - Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getClusterGlobalWrites` - Returns one managed namespace within the specified global cluster. .. toctree:: @@ -67,7 +67,7 @@ Related Commands createCustomZoneMapping createManagedNamespace - deleteAllCustomZoneMappings - deleteManagedNamespace - getManagedNamespace + deleteCustomZoneMapping + deleteManagedNamespaces + getClusterGlobalWrites diff --git a/docs/command/atlas-api-invoices-createCostExplorerProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerProcess.txt new file mode 100644 index 0000000000..1fb9d8cee6 --- /dev/null +++ b/docs/command/atlas-api-invoices-createCostExplorerProcess.txt @@ -0,0 +1,91 @@ +.. _atlas-api-invoices-createCostExplorerProcess: + +============================================ +atlas api invoices createCostExplorerProcess +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a query process within the Cost Explorer for the given parameters. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A token is returned that can be used to poll the status of the query and eventually retrieve the results. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgbillingcostexplorerusageprocess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api invoices createCostExplorerProcess [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createCostExplorerProcess + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt deleted file mode 100644 index eb64947cd1..0000000000 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-api-invoices-createCostExplorerQueryProcess: - -================================================= -atlas api invoices createCostExplorerQueryProcess -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a query process within the Cost Explorer for the given parameters. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A token is returned that can be used to poll the status of the query and eventually retrieve the results. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcostexplorerqueryprocess. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api invoices createCostExplorerQueryProcess [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createCostExplorerQueryProcess - * - --orgId - - string - - true - - 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. - * - -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) - * - --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. - diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt deleted file mode 100644 index 722aa85d85..0000000000 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-invoices-downloadInvoiceCsv: - -===================================== -atlas api invoices downloadInvoiceCsv -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one invoice that MongoDB issued to the specified organization in CSV format. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. -To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadinvoicecsv. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api invoices downloadInvoiceCsv [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. - * - -h, --help - - - - false - - help for downloadInvoiceCsv - * - --invoiceId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. - * - --orgId - - string - - true - - 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. - * - -o, --output - - string - - false - - preferred api format, can be ["csv"] This value defaults to "csv". - * - --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. - * - --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-invoices-downloadInvoiceCsv-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt deleted file mode 100644 index cb311b93bd..0000000000 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-invoices-getCostExplorerQueryProcess: - -============================================== -atlas api invoices getCostExplorerQueryProcess -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcostexplorerqueryprocess. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api invoices getCostExplorerQueryProcess [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. - * - -h, --help - - - - false - - help for getCostExplorerQueryProcess - * - --orgId - - string - - true - - 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. - * - -o, --output - - string - - true - - preferred api format, can be ["csv", "json", go-template] - * - --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) - * - --token - - string - - true - - Unique 64 digit string that identifies the Cost Explorer query. - * - --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-invoices-getCostExplorerQueryProcess-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-invoices-getCostExplorerUsage.txt b/docs/command/atlas-api-invoices-getCostExplorerUsage.txt new file mode 100644 index 0000000000..7c397ab13a --- /dev/null +++ b/docs/command/atlas-api-invoices-getCostExplorerUsage.txt @@ -0,0 +1,91 @@ +.. _atlas-api-invoices-getCostExplorerUsage: + +======================================= +atlas api invoices getCostExplorerUsage +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgbillingcostexplorerusage. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api invoices getCostExplorerUsage [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for getCostExplorerUsage + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -o, --output + - string + - true + - preferred api format, can be ["csv", "json", go-template] + * - --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) + * - --token + - string + - true + - unique 64 digit string that identifies the Cost Explorer query + * - --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. + diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index 4ac8c67920..a8a32020e6 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -20,7 +20,7 @@ Admin API capabilities have their own release lifecycle, which you can check via A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getinvoice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoice. For more information and examples, see the referenced API documentation linked above. @@ -46,9 +46,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - -h, --help - - false @@ -56,11 +56,11 @@ Options * - --invoiceId - string - true - - Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. + - unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - true @@ -72,7 +72,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -94,8 +94,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-invoices-getInvoice-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-invoices-getInvoiceCsv.txt b/docs/command/atlas-api-invoices-getInvoiceCsv.txt new file mode 100644 index 0000000000..6ad8b4285b --- /dev/null +++ b/docs/command/atlas-api-invoices-getInvoiceCsv.txt @@ -0,0 +1,96 @@ +.. _atlas-api-invoices-getInvoiceCsv: + +================================ +atlas api invoices getInvoiceCsv +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one invoice that MongoDB issued to the specified organization in CSV format. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. +To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoicecsv. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api invoices getInvoiceCsv [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for getInvoiceCsv + * - --invoiceId + - string + - true + - unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -o, --output + - string + - false + - preferred api format, can be ["csv"] This value defaults to "csv". + * - --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 + * - --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. + diff --git a/docs/command/atlas-api-invoices-listInvoicePending.txt b/docs/command/atlas-api-invoices-listInvoicePending.txt new file mode 100644 index 0000000000..a48afbd890 --- /dev/null +++ b/docs/command/atlas-api-invoices-listInvoicePending.txt @@ -0,0 +1,91 @@ +.. _atlas-api-invoices-listInvoicePending: + +===================================== +atlas api invoices listInvoicePending +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all invoices accruing charges for the current billing cycle for the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvoicepending. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api invoices listInvoicePending [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listInvoicePending + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index 5d38f9506a..8b4fdf17dd 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -20,7 +20,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listinvoices. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvoices. For more information and examples, see the referenced API documentation linked above. @@ -46,13 +46,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --fromDate - string - false - - Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate. + - retrieve the invoices the startDates of which are greater than or equal to the fromDate * - -h, --help - - false @@ -60,19 +60,19 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - --orderBy - string - false - - Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result. + - field used to order the returned invoices by * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -84,23 +84,23 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --sortBy - string - false - - Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result. + - field used to sort the returned invoices by * - --statusNames - stringArray - false - - Statuses of the invoice to be retrieved. Omit to return invoices of all statuses. + - statuses of the invoice to be retrieved * - --toDate - string - false - - Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate. + - retrieve the invoices the endDates of which are smaller than or equal to the toDate * - --version - string - false @@ -108,7 +108,7 @@ Options * - --viewLinkedInvoices - - false - - Flag that indicates whether to return linked invoices in the linkedInvoices field. + - flag that indicates whether to return linked invoices in the linkedInvoices field Inherited Options ----------------- @@ -126,8 +126,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-invoices-listInvoices-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt deleted file mode 100644 index 491e7e5ce2..0000000000 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-invoices-listPendingInvoices: - -====================================== -atlas api invoices listPendingInvoices -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all invoices accruing charges for the current billing cycle for the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpendinginvoices. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api invoices listPendingInvoices [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. - * - -h, --help - - - - false - - help for listPendingInvoices - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-invoices-listPendingInvoices-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt deleted file mode 100644 index 72d042dce2..0000000000 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-api-invoices-queryLineItemsFromSingleInvoice: - -================================================== -atlas api invoices queryLineItemsFromSingleInvoice -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Query the lineItems of the specified invoice and return the result JSON. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A unique 24-hexadecimal digit string identifies the invoice. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-querylineitemsfromsingleinvoice. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api invoices queryLineItemsFromSingleInvoice [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for queryLineItemsFromSingleInvoice - * - --invoiceId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-invoices-searchInvoiceLineItems.txt b/docs/command/atlas-api-invoices-searchInvoiceLineItems.txt new file mode 100644 index 0000000000..e93f506e3d --- /dev/null +++ b/docs/command/atlas-api-invoices-searchInvoiceLineItems.txt @@ -0,0 +1,103 @@ +.. _atlas-api-invoices-searchInvoiceLineItems: + +========================================= +atlas api invoices searchInvoiceLineItems +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Query the lineItems of the specified invoice and return the result JSON. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A unique 24-hexadecimal digit string identifies the invoice. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-searchorginvoicelineitems. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api invoices searchInvoiceLineItems [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for searchInvoiceLineItems + * - --invoiceId + - string + - true + - unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index a94bd24b46..7effb1e9c9 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -54,23 +54,23 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +* :ref:`atlas-api-invoices-createCostExplorerProcess` - Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-getCostExplorerUsage` - Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. * :ref:`atlas-api-invoices-getInvoice` - Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-getInvoiceCsv` - Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-listInvoicePending` - Returns all invoices accruing charges for the current billing cycle for the specified organization. * :ref:`atlas-api-invoices-listInvoices` - Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-searchInvoiceLineItems` - Query the lineItems of the specified invoice and return the result JSON. .. toctree:: :titlesonly: - createCostExplorerQueryProcess - downloadInvoiceCsv - getCostExplorerQueryProcess + createCostExplorerProcess + getCostExplorerUsage getInvoice + getInvoiceCsv + listInvoicePending listInvoices - listPendingInvoices - queryLineItemsFromSingleInvoice + searchInvoiceLineItems diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt deleted file mode 100644 index f5f0c82776..0000000000 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-ldapConfiguration-deleteLdapConfiguration: - -=================================================== -atlas api ldapConfiguration deleteLdapConfiguration -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteldapconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api ldapConfiguration deleteLdapConfiguration [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 deleteLdapConfiguration - * - -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. - * - --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-ldapConfiguration-deleteLdapConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapUserMapping.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapUserMapping.txt new file mode 100644 index 0000000000..bf344d33d5 --- /dev/null +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapUserMapping.txt @@ -0,0 +1,91 @@ +.. _atlas-api-ldapConfiguration-deleteLdapUserMapping: + +================================================= +atlas api ldapConfiguration deleteLdapUserMapping +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupusersecurityldapusertodnmapping. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api ldapConfiguration deleteLdapUserMapping [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteLdapUserMapping + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt deleted file mode 100644 index 3eb6c9eb77..0000000000 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-ldapConfiguration-getLdapConfiguration: - -================================================ -atlas api ldapConfiguration getLdapConfiguration -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the current LDAP configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api ldapConfiguration getLdapConfiguration [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 getLdapConfiguration - * - -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. - * - --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-ldapConfiguration-getLdapConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt deleted file mode 100644 index 9ec9b2a8c4..0000000000 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-ldapConfiguration-getLdapConfigurationStatus: - -====================================================== -atlas api ldapConfiguration getLdapConfigurationStatus -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the status of one request to verify one LDAP configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfigurationstatus. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api ldapConfiguration getLdapConfigurationStatus [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 getLdapConfigurationStatus - * - -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. - * - --requestId - - string - - true - - Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration. - * - --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-ldapConfiguration-getLdapConfigurationStatus-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-ldapConfiguration-getUserSecurity.txt b/docs/command/atlas-api-ldapConfiguration-getUserSecurity.txt new file mode 100644 index 0000000000..f3da8d03d3 --- /dev/null +++ b/docs/command/atlas-api-ldapConfiguration-getUserSecurity.txt @@ -0,0 +1,91 @@ +.. _atlas-api-ldapConfiguration-getUserSecurity: + +=========================================== +atlas api ldapConfiguration getUserSecurity +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the current LDAP configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupusersecurity. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api ldapConfiguration getUserSecurity [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getUserSecurity + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-ldapConfiguration-getUserSecurityVerify.txt b/docs/command/atlas-api-ldapConfiguration-getUserSecurityVerify.txt new file mode 100644 index 0000000000..d2aa806672 --- /dev/null +++ b/docs/command/atlas-api-ldapConfiguration-getUserSecurityVerify.txt @@ -0,0 +1,95 @@ +.. _atlas-api-ldapConfiguration-getUserSecurityVerify: + +================================================= +atlas api ldapConfiguration getUserSecurityVerify +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the status of one request to verify one LDAP configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupusersecurityldapverify. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api ldapConfiguration getUserSecurityVerify [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getUserSecurityVerify + * - -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 + * - --requestId + - string + - true + - unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration + * - --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. + diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt deleted file mode 100644 index 75994909af..0000000000 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-ldapConfiguration-saveLdapConfiguration: - -================================================= -atlas api ldapConfiguration saveLdapConfiguration -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Edits the LDAP configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Updating this configuration triggers a rolling restart of the database. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-saveldapconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api ldapConfiguration saveLdapConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 saveLdapConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-ldapConfiguration-updateUserSecurity.txt b/docs/command/atlas-api-ldapConfiguration-updateUserSecurity.txt new file mode 100644 index 0000000000..47205d63df --- /dev/null +++ b/docs/command/atlas-api-ldapConfiguration-updateUserSecurity.txt @@ -0,0 +1,98 @@ +.. _atlas-api-ldapConfiguration-updateUserSecurity: + +============================================== +atlas api ldapConfiguration updateUserSecurity +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Edits the LDAP configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +Updating this configuration triggers a rolling restart of the database. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupusersecurity. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api ldapConfiguration updateUserSecurity [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateUserSecurity + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt deleted file mode 100644 index 330461638f..0000000000 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-ldapConfiguration-verifyLdapConfiguration: - -=================================================== -atlas api ldapConfiguration verifyLdapConfiguration -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Verifies the LDAP configuration for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyldapconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api ldapConfiguration verifyLdapConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 verifyLdapConfiguration - * - -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. - * - --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". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -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. - diff --git a/docs/command/atlas-api-ldapConfiguration-verifyUserSecurityLdap.txt b/docs/command/atlas-api-ldapConfiguration-verifyUserSecurityLdap.txt new file mode 100644 index 0000000000..414f9f0fd5 --- /dev/null +++ b/docs/command/atlas-api-ldapConfiguration-verifyUserSecurityLdap.txt @@ -0,0 +1,103 @@ +.. _atlas-api-ldapConfiguration-verifyUserSecurityLdap: + +================================================== +atlas api ldapConfiguration verifyUserSecurityLdap +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Verifies the LDAP configuration for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifygroupusersecurityldap. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api ldapConfiguration verifyUserSecurityLdap [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for verifyUserSecurityLdap + * - -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 + * - --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". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +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. + diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index 6192d18453..56198c0108 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -54,19 +54,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapUserMapping` - Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getUserSecurity` - Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getUserSecurityVerify` - Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-updateUserSecurity` - Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyUserSecurityLdap` - Verifies the LDAP configuration for the specified project. .. toctree:: :titlesonly: - deleteLdapConfiguration - getLdapConfiguration - getLdapConfigurationStatus - saveLdapConfiguration - verifyLdapConfiguration + deleteLdapUserMapping + getUserSecurity + getUserSecurityVerify + updateUserSecurity + verifyUserSecurityLdap diff --git a/docs/command/atlas-api-legacyBackup-createClusterRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createClusterRestoreJob.txt new file mode 100644 index 0000000000..bbdc318f7e --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-createClusterRestoreJob.txt @@ -0,0 +1,99 @@ +.. _atlas-api-legacyBackup-createClusterRestoreJob: + +============================================== +atlas api legacyBackup createClusterRestoreJob +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Restores one legacy backup for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterrestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup createClusterRestoreJob [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 with the snapshot you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createClusterRestoreJob + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt deleted file mode 100644 index 487c29cdab..0000000000 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-legacyBackup-createLegacyBackupRestoreJob: - -=================================================== -atlas api legacyBackup createLegacyBackupRestoreJob -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restores one legacy backup for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlegacybackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup createLegacyBackupRestoreJob [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 with the snapshot you want to return. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createLegacyBackupRestoreJob - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-legacyBackup-deleteClusterSnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteClusterSnapshot.txt new file mode 100644 index 0000000000..a7d7f3ef27 --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-deleteClusterSnapshot.txt @@ -0,0 +1,99 @@ +.. _atlas-api-legacyBackup-deleteClusterSnapshot: + +============================================ +atlas api legacyBackup deleteClusterSnapshot +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one legacy backup snapshot for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup deleteClusterSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteClusterSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt deleted file mode 100644 index db91b9dbc3..0000000000 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-legacyBackup-deleteLegacySnapshot: - -=========================================== -atlas api legacyBackup deleteLegacySnapshot -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one legacy backup snapshot for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelegacysnapshot. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup deleteLegacySnapshot [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 deleteLegacySnapshot - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-legacyBackup-deleteLegacySnapshot-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-getClusterBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getClusterBackupCheckpoint.txt new file mode 100644 index 0000000000..91b91b5c3a --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-getClusterBackupCheckpoint.txt @@ -0,0 +1,99 @@ +.. _atlas-api-legacyBackup-getClusterBackupCheckpoint: + +================================================= +atlas api legacyBackup getClusterBackupCheckpoint +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one legacy backup checkpoint for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupcheckpoint. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup getClusterBackupCheckpoint [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 + * - --checkpointId + - string + - true + - unique 24-hexadecimal digit string that identifies the checkpoint + * - --clusterName + - string + - true + - human-readable label that identifies the cluster that contains the checkpoints that you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterBackupCheckpoint + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-getClusterRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getClusterRestoreJob.txt new file mode 100644 index 0000000000..067c6e4c07 --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-getClusterRestoreJob.txt @@ -0,0 +1,102 @@ +.. _atlas-api-legacyBackup-getClusterRestoreJob: + +=========================================== +atlas api legacyBackup getClusterRestoreJob +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one legacy backup restore job for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterrestorejob. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup getClusterRestoreJob [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 with the snapshot you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterRestoreJob + * - --jobId + - string + - true + - unique 24-hexadecimal digit string that identifies the restore job + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-getClusterSnapshot.txt b/docs/command/atlas-api-legacyBackup-getClusterSnapshot.txt new file mode 100644 index 0000000000..0a8eda8b2c --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-getClusterSnapshot.txt @@ -0,0 +1,99 @@ +.. _atlas-api-legacyBackup-getClusterSnapshot: + +========================================= +atlas api legacyBackup getClusterSnapshot +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one legacy backup snapshot for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup getClusterSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-getClusterSnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getClusterSnapshotSchedule.txt new file mode 100644 index 0000000000..2db37d6e7d --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-getClusterSnapshotSchedule.txt @@ -0,0 +1,98 @@ +.. _atlas-api-legacyBackup-getClusterSnapshotSchedule: + +================================================= +atlas api legacyBackup getClusterSnapshotSchedule +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the snapshot schedule for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersnapshotschedule. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup getClusterSnapshotSchedule [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 with the snapshot you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getClusterSnapshotSchedule + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt deleted file mode 100644 index cabc653943..0000000000 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-legacyBackup-getLegacyBackupCheckpoint: - -================================================ -atlas api legacyBackup getLegacyBackupCheckpoint -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one legacy backup checkpoint for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacybackupcheckpoint. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup getLegacyBackupCheckpoint [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 - * - --checkpointId - - string - - true - - Unique 24-hexadecimal digit string that identifies the checkpoint. - * - --clusterName - - string - - true - - Human-readable label that identifies the cluster that contains the checkpoints that you want to return. - * - --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 getLegacyBackupCheckpoint - * - -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. - * - --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-legacyBackup-getLegacyBackupCheckpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt deleted file mode 100644 index 8b70b75aab..0000000000 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-legacyBackup-getLegacyBackupRestoreJob: - -================================================ -atlas api legacyBackup getLegacyBackupRestoreJob -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one legacy backup restore job for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacybackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup getLegacyBackupRestoreJob [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 with the snapshot you want to return. - * - --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 getLegacyBackupRestoreJob - * - --jobId - - string - - true - - Unique 24-hexadecimal digit string that identifies the restore job. - * - -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. - * - --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-legacyBackup-getLegacyBackupRestoreJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt deleted file mode 100644 index 151b2aa6b7..0000000000 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-legacyBackup-getLegacySnapshot: - -======================================== -atlas api legacyBackup getLegacySnapshot -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one legacy backup snapshot for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacysnapshot. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup getLegacySnapshot [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 getLegacySnapshot - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-legacyBackup-getLegacySnapshot-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt deleted file mode 100644 index 29ae291bda..0000000000 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-legacyBackup-getLegacySnapshotSchedule: - -================================================ -atlas api legacyBackup getLegacySnapshotSchedule -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the snapshot schedule for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacysnapshotschedule. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup getLegacySnapshotSchedule [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 with the snapshot you want to return. - * - --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 getLegacySnapshotSchedule - * - -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. - * - --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-legacyBackup-getLegacySnapshotSchedule-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-listClusterBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listClusterBackupCheckpoints.txt new file mode 100644 index 0000000000..2a6575e96b --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-listClusterBackupCheckpoints.txt @@ -0,0 +1,107 @@ +.. _atlas-api-legacyBackup-listClusterBackupCheckpoints: + +=================================================== +atlas api legacyBackup listClusterBackupCheckpoints +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all legacy backup checkpoints for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupcheckpoints. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup listClusterBackupCheckpoints [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 that contains the checkpoints that you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterBackupCheckpoints + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-listClusterRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listClusterRestoreJobs.txt new file mode 100644 index 0000000000..a25e4df0f3 --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-listClusterRestoreJobs.txt @@ -0,0 +1,114 @@ +.. _atlas-api-legacyBackup-listClusterRestoreJobs: + +============================================= +atlas api legacyBackup listClusterRestoreJobs +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all legacy backup restore jobs for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterrestorejobs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup listClusterRestoreJobs [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 + * - --batchId + - string + - false + - unique 24-hexadecimal digit string that identifies the batch of restore jobs to return + * - --clusterName + - string + - true + - human-readable label that identifies the cluster with the snapshot you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterRestoreJobs + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-listClusterSnapshots.txt b/docs/command/atlas-api-legacyBackup-listClusterSnapshots.txt new file mode 100644 index 0000000000..9ba225c686 --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-listClusterSnapshots.txt @@ -0,0 +1,111 @@ +.. _atlas-api-legacyBackup-listClusterSnapshots: + +=========================================== +atlas api legacyBackup listClusterSnapshots +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all legacy backup snapshots for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup listClusterSnapshots [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 + * - --completed + - string + - false + - human-readable label that specifies whether to return only completed, incomplete, or all snapshots + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterSnapshots + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt deleted file mode 100644 index a4b2305837..0000000000 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-legacyBackup-listLegacyBackupCheckpoints: - -================================================== -atlas api legacyBackup listLegacyBackupCheckpoints -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all legacy backup checkpoints for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacybackupcheckpoints. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup listLegacyBackupCheckpoints [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 that contains the checkpoints that you want to return. - * - --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 listLegacyBackupCheckpoints - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-legacyBackup-listLegacyBackupCheckpoints-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt deleted file mode 100644 index f501fa13eb..0000000000 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ /dev/null @@ -1,121 +0,0 @@ -.. _atlas-api-legacyBackup-listLegacyBackupRestoreJobs: - -================================================== -atlas api legacyBackup listLegacyBackupRestoreJobs -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all legacy backup restore jobs for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacybackuprestorejobs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup listLegacyBackupRestoreJobs [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 - * - --batchId - - string - - false - - Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch. - * - --clusterName - - string - - true - - Human-readable label that identifies the cluster with the snapshot you want to return. - * - --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 listLegacyBackupRestoreJobs - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-legacyBackup-listLegacyBackupRestoreJobs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt deleted file mode 100644 index 2a0611c74e..0000000000 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-api-legacyBackup-listLegacySnapshots: - -========================================== -atlas api legacyBackup listLegacySnapshots -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all legacy backup snapshots for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacysnapshots. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup listLegacySnapshots [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. - * - --completed - - string - - false - - Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots. - * - --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 listLegacySnapshots - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-legacyBackup-listLegacySnapshots-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-legacyBackup-updateClusterSnapshot.txt b/docs/command/atlas-api-legacyBackup-updateClusterSnapshot.txt new file mode 100644 index 0000000000..49eb8cdd5d --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-updateClusterSnapshot.txt @@ -0,0 +1,103 @@ +.. _atlas-api-legacyBackup-updateClusterSnapshot: + +============================================ +atlas api legacyBackup updateClusterSnapshot +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup updateClusterSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateClusterSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-updateClusterSnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateClusterSnapshotSchedule.txt new file mode 100644 index 0000000000..eb93c6d172 --- /dev/null +++ b/docs/command/atlas-api-legacyBackup-updateClusterSnapshotSchedule.txt @@ -0,0 +1,102 @@ +.. _atlas-api-legacyBackup-updateClusterSnapshotSchedule: + +==================================================== +atlas api legacyBackup updateClusterSnapshotSchedule +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the snapshot schedule for one cluster in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersnapshotschedule. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api legacyBackup updateClusterSnapshotSchedule [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 with the snapshot you want to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateClusterSnapshotSchedule + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt deleted file mode 100644 index f2ed39a4e2..0000000000 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-legacyBackup-updateLegacySnapshotRetention: - -==================================================== -atlas api legacyBackup updateLegacySnapshotRetention -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatelegacysnapshotretention. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup updateLegacySnapshotRetention [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateLegacySnapshotRetention - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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. - diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt deleted file mode 100644 index 736e88d474..0000000000 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-legacyBackup-updateLegacySnapshotSchedule: - -=================================================== -atlas api legacyBackup updateLegacySnapshotSchedule -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the snapshot schedule for one cluster in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatelegacysnapshotschedule. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api legacyBackup updateLegacySnapshotSchedule [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 with the snapshot you want to return. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateLegacySnapshotSchedule - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index 46d25f2bc0..98c24e7ba1 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -54,31 +54,31 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createClusterRestoreJob` - Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteClusterSnapshot` - Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getClusterBackupCheckpoint` - Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getClusterRestoreJob` - Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getClusterSnapshot` - Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getClusterSnapshotSchedule` - Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listClusterBackupCheckpoints` - Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listClusterRestoreJobs` - Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listClusterSnapshots` - Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateClusterSnapshot` - Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateClusterSnapshotSchedule` - Updates the snapshot schedule for one cluster in the specified project. .. toctree:: :titlesonly: - createLegacyBackupRestoreJob - deleteLegacySnapshot - getLegacyBackupCheckpoint - getLegacyBackupRestoreJob - getLegacySnapshot - getLegacySnapshotSchedule - listLegacyBackupCheckpoints - listLegacyBackupRestoreJobs - listLegacySnapshots - updateLegacySnapshotRetention - updateLegacySnapshotSchedule + createClusterRestoreJob + deleteClusterSnapshot + getClusterBackupCheckpoint + getClusterRestoreJob + getClusterSnapshot + getClusterSnapshotSchedule + listClusterBackupCheckpoints + listClusterRestoreJobs + listClusterSnapshots + updateClusterSnapshot + updateClusterSnapshotSchedule diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index a12219c0d9..578e3bc16a 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-defermaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-defergroupmaintenancewindow. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -87,8 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-maintenanceWindows-deferMaintenanceWindow-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index f3564540d6..36a288126b 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupmaintenancewindow. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,7 +67,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -91,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-maintenanceWindows-getMaintenanceWindow-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 02ac37005d..788b151a49 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resetmaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resetgroupmaintenancewindow. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -87,8 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-maintenanceWindows-resetMaintenanceWindow-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 6d6a1ac072..097eef35dc 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglemaintenanceautodefer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupmaintenancewindowautodefer. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -87,8 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index ea6a5a3421..5408072ba5 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatemaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupmaintenancewindow. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addGroupUserRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addGroupUserRole.txt new file mode 100644 index 0000000000..feb19daa12 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-addGroupUserRole.txt @@ -0,0 +1,104 @@ +.. _atlas-api-mongoDbCloudUsers-addGroupUserRole: + +============================================ +atlas api mongoDbCloudUsers addGroupUserRole +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one project-level role to the MongoDB Cloud user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupuserrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers addGroupUserRole [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 addGroupUserRole + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addGroupUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-addGroupUsers.txt new file mode 100644 index 0000000000..773a2b774d --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-addGroupUsers.txt @@ -0,0 +1,107 @@ +.. _atlas-api-mongoDbCloudUsers-addGroupUsers: + +========================================= +atlas api mongoDbCloudUsers addGroupUsers +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one MongoDB Cloud user to one project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + + +If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. + + +If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. + + +If the user is already active in the project's organization, MongoDB Cloud grants access to the project. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupusers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers addGroupUsers [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 addGroupUsers + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrgRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrgRole.txt new file mode 100644 index 0000000000..8a2fd05832 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrgRole.txt @@ -0,0 +1,105 @@ +.. _atlas-api-mongoDbCloudUsers-addOrgRole: + +====================================== +atlas api mongoDbCloudUsers addOrgRole +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one organization-level role to the MongoDB Cloud user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This operation is atomic. + + +Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorguserrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers addOrgRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for addOrgRole + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --userId + - string + - true + - unique 24-hexadecimal digit string that identifies the pending or active user in the organization + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrgTeamUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrgTeamUser.txt new file mode 100644 index 0000000000..0bdb2fd778 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrgTeamUser.txt @@ -0,0 +1,102 @@ +.. _atlas-api-mongoDbCloudUsers-addOrgTeamUser: + +========================================== +atlas api mongoDbCloudUsers addOrgTeamUser +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one MongoDB Cloud user to one team. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorgteamuser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers addOrgTeamUser [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for addOrgTeamUser + * - --orgId + - string + - true + - 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. + * - -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 to add the MongoDB Cloud user to. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt deleted file mode 100644 index 84b11b0572..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-addOrganizationRole: - -=============================================== -atlas api mongoDbCloudUsers addOrganizationRole -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one organization-level role to the MongoDB Cloud user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This operation is atomic. - - -Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorganizationrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers addOrganizationRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for addOrganizationRole - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt deleted file mode 100644 index 4f1951c984..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-addProjectRole: - -========================================== -atlas api mongoDbCloudUsers addProjectRole -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one project-level role to the MongoDB Cloud user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers addProjectRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addProjectRole - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt deleted file mode 100644 index 15186f9a34..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-addProjectUser: - -========================================== -atlas api mongoDbCloudUsers addProjectUser -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one MongoDB Cloud user to one project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - - -If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. - - -If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. - - -If the user is already active in the project's organization, MongoDB Cloud grants access to the project. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers addProjectUser [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addProjectUser - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt deleted file mode 100644 index a868ab6971..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-addUserToTeam: - -========================================= -atlas api mongoDbCloudUsers addUserToTeam -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one MongoDB Cloud user to one team. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addusertoteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers addUserToTeam [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for addUserToTeam - * - --orgId - - string - - true - - 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. - * - -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 to add the MongoDB Cloud user to. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrgUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrgUser.txt new file mode 100644 index 0000000000..ef62201b2f --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrgUser.txt @@ -0,0 +1,98 @@ +.. _atlas-api-mongoDbCloudUsers-createOrgUser: + +========================================= +atlas api mongoDbCloudUsers createOrgUser +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invites one new or existing MongoDB Cloud user to join the organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorguser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers createOrgUser [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgUser + * - --orgId + - string + - true + - 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. + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt deleted file mode 100644 index 1fdf11f486..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-createOrganizationUser: - -================================================== -atlas api mongoDbCloudUsers createOrganizationUser -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invites one new or existing MongoDB Cloud user to join the organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganizationuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers createOrganizationUser [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createOrganizationUser - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getGroupUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getGroupUser.txt new file mode 100644 index 0000000000..ba0063bf2b --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-getGroupUser.txt @@ -0,0 +1,108 @@ +.. _atlas-api-mongoDbCloudUsers-getGroupUser: + +======================================== +atlas api mongoDbCloudUsers getGroupUser +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns information about the specified MongoDB Cloud user within the context of the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. + + +Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupuser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers getGroupUser [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 getGroupUser + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-getGroupUser-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrgUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrgUser.txt new file mode 100644 index 0000000000..45b92f78d5 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrgUser.txt @@ -0,0 +1,106 @@ +.. _atlas-api-mongoDbCloudUsers-getOrgUser: + +====================================== +atlas api mongoDbCloudUsers getOrgUser +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns information about the specified MongoDB Cloud user within the context of the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + + +Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. + + +Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorguser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers getOrgUser [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. + * - -h, --help + - + - false + - help for getOrgUser + * - --orgId + - string + - true + - 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. + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-getOrgUser-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt deleted file mode 100644 index 54af116288..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-getOrganizationUser: - -=============================================== -atlas api mongoDbCloudUsers getOrganizationUser -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns information about the specified MongoDB Cloud user within the context of the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - - -Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. - - -Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers getOrganizationUser [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. - * - -h, --help - - - - false - - help for getOrganizationUser - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-getOrganizationUser-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt deleted file mode 100644 index 8111663b2c..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-getProjectUser: - -========================================== -atlas api mongoDbCloudUsers getProjectUser -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns information about the specified MongoDB Cloud user within the context of the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. - - -Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers getProjectUser [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 getProjectUser - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-getProjectUser-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByName.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByName.txt new file mode 100644 index 0000000000..1329c0efac --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByName.txt @@ -0,0 +1,91 @@ +.. _atlas-api-mongoDbCloudUsers-getUserByName: + +========================================= +atlas api mongoDbCloudUsers getUserByName +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details for one MongoDB Cloud user account with the specified username. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyname. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers getUserByName [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. + * - -h, --help + - + - false + - help for getUserByName + * - -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. + * - --userName + - string + - true + - Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user. + * - --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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt deleted file mode 100644 index a6891af2c7..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-getUserByUsername: - -============================================= -atlas api mongoDbCloudUsers getUserByUsername -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details for one MongoDB Cloud user account with the specified username. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyusername. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers getUserByUsername [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. - * - -h, --help - - - - false - - help for getUserByUsername - * - -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. - * - --userName - - string - - true - - Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user. - * - --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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listGroupUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listGroupUsers.txt new file mode 100644 index 0000000000..d265960003 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-listGroupUsers.txt @@ -0,0 +1,132 @@ +.. _atlas-api-mongoDbCloudUsers-listGroupUsers: + +========================================== +atlas api mongoDbCloudUsers listGroupUsers +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the pending and active MongoDB Cloud users associated with the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + + +Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupusers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers listGroupUsers [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. + * - --flattenTeams + - "flattenTeams" : false + - false + - Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If `"flattenTeams" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project. + * - --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 listGroupUsers + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --includeOrgUsers + - "includeOrgUsers": false + - false + - Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If `"includeOrgUsers": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --orgMembershipStatus + - string + - false + - Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --username + - string + - false + - Email address to filter users by. Not supported in deprecated versions. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-listGroupUsers-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrgUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrgUsers.txt new file mode 100644 index 0000000000..37c18474c3 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrgUsers.txt @@ -0,0 +1,122 @@ +.. _atlas-api-mongoDbCloudUsers-listOrgUsers: + +======================================== +atlas api mongoDbCloudUsers listOrgUsers +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the pending and active MongoDB Cloud users associated with the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + + +Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + + +Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgusers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers listOrgUsers [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. + * - -h, --help + - + - false + - help for listOrgUsers + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --orgId + - string + - true + - 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. + * - --orgMembershipStatus + - string + - false + - Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --username + - string + - false + - Email address to filter users by. Not supported in deprecated versions. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-listOrgUsers-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt deleted file mode 100644 index c33380542f..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-listOrganizationUsers: - -================================================= -atlas api mongoDbCloudUsers listOrganizationUsers -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the pending and active MongoDB Cloud users associated with the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - - -Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - - -Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationusers. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers listOrganizationUsers [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. - * - -h, --help - - - - false - - help for listOrganizationUsers - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - --orgMembershipStatus - - string - - false - - Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --username - - string - - false - - Email address to filter users by. Not supported in deprecated versions. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-listOrganizationUsers-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt deleted file mode 100644 index 26509a596b..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ /dev/null @@ -1,132 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-listProjectUsers: - -============================================ -atlas api mongoDbCloudUsers listProjectUsers -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the pending and active MongoDB Cloud users associated with the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - - -Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectusers. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers listProjectUsers [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. - * - --flattenTeams - - "flattenTeams" : false - - false - - Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If `"flattenTeams" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project. - * - --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 listProjectUsers - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --includeOrgUsers - - "includeOrgUsers": false - - false - - Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If `"includeOrgUsers": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgMembershipStatus - - string - - false - - Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --username - - string - - false - - Email address to filter users by. Not supported in deprecated versions. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-listProjectUsers-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index a1c0dbb9c0..2580e34bbc 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -25,7 +25,7 @@ Note: This resource cannot be used to view details about users invited via the d Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listteamusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgteamusers. For more information and examples, see the referenced API documentation linked above. @@ -51,9 +51,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - -h, --help - - false @@ -61,15 +61,15 @@ Options * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - --orgMembershipStatus - string - false - - Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. + - organization membership status to filter users by * - -o, --output - string - false @@ -81,23 +81,23 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --teamId - string - true - - Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. + - unique 24-hexadecimal digit string that identifies the team whose application users you want to return * - --userId - string - false - - Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions. + - unique 24-hexadecimal digit string to filter users by * - --username - string - false - - Email address to filter users by. Not supported in deprecated versions. + - email address to filter users by * - --version - string - false @@ -119,8 +119,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-mongoDbCloudUsers-listTeamUsers-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUser.txt new file mode 100644 index 0000000000..9eb1f94f95 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUser.txt @@ -0,0 +1,108 @@ +.. _atlas-api-mongoDbCloudUsers-removeGroupUser: + +=========================================== +atlas api mongoDbCloudUsers removeGroupUser +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one MongoDB Cloud user from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + + +Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupuser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers removeGroupUser [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 removeGroupUser + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-removeGroupUser-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUserRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUserRole.txt new file mode 100644 index 0000000000..c487c0986d --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeGroupUserRole.txt @@ -0,0 +1,104 @@ +.. _atlas-api-mongoDbCloudUsers-removeGroupUserRole: + +=============================================== +atlas api mongoDbCloudUsers removeGroupUserRole +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one project-level role from the MongoDB Cloud user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupuserrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers removeGroupUserRole [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 removeGroupUserRole + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrgRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgRole.txt new file mode 100644 index 0000000000..fba13569e3 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgRole.txt @@ -0,0 +1,105 @@ +.. _atlas-api-mongoDbCloudUsers-removeOrgRole: + +========================================= +atlas api mongoDbCloudUsers removeOrgRole +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one organization-level role from the MongoDB Cloud user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This operation is atomic. + + +Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorguserrole. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers removeOrgRole [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for removeOrgRole + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --userId + - string + - true + - unique 24-hexadecimal digit string that identifies the pending or active user in the organization + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrgTeamUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgTeamUser.txt new file mode 100644 index 0000000000..53f4a1313a --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgTeamUser.txt @@ -0,0 +1,102 @@ +.. _atlas-api-mongoDbCloudUsers-removeOrgTeamUser: + +============================================= +atlas api mongoDbCloudUsers removeOrgTeamUser +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one MongoDB Cloud user from one team. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorgteamuser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers removeOrgTeamUser [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for removeOrgTeamUser + * - --orgId + - string + - true + - 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. + * - -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 to remove the MongoDB user from. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrgUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgUser.txt new file mode 100644 index 0000000000..9cad14a275 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrgUser.txt @@ -0,0 +1,106 @@ +.. _atlas-api-mongoDbCloudUsers-removeOrgUser: + +========================================= +atlas api mongoDbCloudUsers removeOrgUser +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one MongoDB Cloud user in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + + +Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorguser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers removeOrgUser [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. + * - -h, --help + - + - false + - help for removeOrgUser + * - --orgId + - string + - true + - 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. + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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-mongoDbCloudUsers-removeOrgUser-2025-02-19-default.sh + :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt deleted file mode 100644 index a61b8ce361..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-removeOrganizationRole: - -================================================== -atlas api mongoDbCloudUsers removeOrganizationRole -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one organization-level role from the MongoDB Cloud user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This operation is atomic. - - -Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorganizationrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers removeOrganizationRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for removeOrganizationRole - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt deleted file mode 100644 index 468d21a85f..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-removeOrganizationUser: - -================================================== -atlas api mongoDbCloudUsers removeOrganizationUser -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one MongoDB Cloud user in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - - -Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorganizationuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers removeOrganizationUser [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. - * - -h, --help - - - - false - - help for removeOrganizationUser - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-removeOrganizationUser-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt deleted file mode 100644 index c194e1a250..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-removeProjectRole: - -============================================= -atlas api mongoDbCloudUsers removeProjectRole -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one project-level role from the MongoDB Cloud user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectrole. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers removeProjectRole [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 removeProjectRole - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt deleted file mode 100644 index 85fd5e7e57..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-removeProjectUser: - -============================================= -atlas api mongoDbCloudUsers removeProjectUser -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one MongoDB Cloud user from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - - -Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers removeProjectUser [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 removeProjectUser - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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-mongoDbCloudUsers-removeProjectUser-2025-02-19-default.sh - :language: shell diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt deleted file mode 100644 index f02e8c486f..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-removeUserFromTeam: - -============================================== -atlas api mongoDbCloudUsers removeUserFromTeam -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one MongoDB Cloud user from one team. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeuserfromteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers removeUserFromTeam [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for removeUserFromTeam - * - --orgId - - string - - true - - 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. - * - -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 to remove the MongoDB user from. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrgUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrgUser.txt new file mode 100644 index 0000000000..2a3aa40989 --- /dev/null +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrgUser.txt @@ -0,0 +1,105 @@ +.. _atlas-api-mongoDbCloudUsers-updateOrgUser: + +========================================= +atlas api mongoDbCloudUsers updateOrgUser +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one MongoDB Cloud user in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. + + +Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorguser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api mongoDbCloudUsers updateOrgUser [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgUser + * - --orgId + - string + - true + - 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. + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". + +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. + diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt deleted file mode 100644 index 4912e0abee..0000000000 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-mongoDbCloudUsers-updateOrganizationUser: - -================================================== -atlas api mongoDbCloudUsers updateOrganizationUser -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one MongoDB Cloud user in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. - - -Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api mongoDbCloudUsers updateOrganizationUser [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganizationUser - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. - * - --version - - string - - false - - api version to use when calling the api call [options: "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19". - -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. - diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 6c12153279..9b6639f791 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -54,47 +54,47 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-addGroupUserRole` - Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addGroupUsers` - Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addOrgRole` - Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addOrgTeamUser` - Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrgUser` - Invites one new or existing MongoDB Cloud user to join the organization. * :ref:`atlas-api-mongoDbCloudUsers-createUser` - Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getGroupUser` - Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getOrgUser` - Returns information about the specified MongoDB Cloud user within the context of the specified organization. * :ref:`atlas-api-mongoDbCloudUsers-getUser` - Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByName` - Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-listGroupUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-listOrgUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified organization. * :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeGroupUser` - Removes one MongoDB Cloud user from the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-removeGroupUserRole` - Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrgRole` - Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrgTeamUser` - Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrgUser` - Removes one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrgUser` - Updates one MongoDB Cloud user in the specified organization. .. toctree:: :titlesonly: - addOrganizationRole - addProjectRole - addProjectUser - addUserToTeam - createOrganizationUser + addGroupUserRole + addGroupUsers + addOrgRole + addOrgTeamUser + createOrgUser createUser - getOrganizationUser - getProjectUser + getGroupUser + getOrgUser getUser - getUserByUsername - listOrganizationUsers - listProjectUsers + getUserByName + listGroupUsers + listOrgUsers listTeamUsers - removeOrganizationRole - removeOrganizationUser - removeProjectRole - removeProjectUser - removeUserFromTeam - updateOrganizationUser + removeGroupUser + removeGroupUserRole + removeOrgRole + removeOrgTeamUser + removeOrgUser + updateOrgUser diff --git a/docs/command/atlas-api-monitoringAndLogs-downloadClusterLog.txt b/docs/command/atlas-api-monitoringAndLogs-downloadClusterLog.txt new file mode 100644 index 0000000000..b2957c9e0d --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-downloadClusterLog.txt @@ -0,0 +1,103 @@ +.. _atlas-api-monitoringAndLogs-downloadClusterLog: + +============================================== +atlas api monitoringAndLogs downloadClusterLog +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusterlog. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs downloadClusterLog [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 + * - --endDate + - int + - false + - specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for downloadClusterLog + * - --hostName + - string + - true + - human-readable label that identifies the host that stores the log files that you want to download + * - --logName + - string + - true + - human-readable label that identifies the log file that you want to return + * - -o, --output + - string + - false + - preferred api format, can be ["gzip"] This value defaults to "gzip". + * - --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) + * - --startDate + - int + - false + - specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-01-01", "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt deleted file mode 100644 index b4e9e55473..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getAtlasProcess: - -=========================================== -atlas api monitoringAndLogs getAtlasProcess -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the processes for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlasprocess. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getAtlasProcess [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 getAtlasProcess - * - -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. - * - --processId - - mongod - - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --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-monitoringAndLogs-getAtlasProcess-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index 0d66472be0..9d569439bd 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdatabase. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --databaseName - string - true - - Human-readable label that identifies the database that the specified MongoDB process serves. + - human-readable label that identifies the database that the specified MongoDB process serves * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processId - - mongod + - string - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-monitoringAndLogs-getDatabase-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 58bfea356c..4e00141676 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabasemeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdatabasemeasurements. For more information and examples, see the referenced API documentation linked above. @@ -47,33 +47,31 @@ Options * - --databaseName - string - true - - Human-readable label that identifies the database that the specified MongoDB process serves. + - human-readable label that identifies the database that the specified MongoDB process serves * - --end - string - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. + - date and time when MongoDB Cloud stops reporting the metrics * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --granularity - string - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. + - duration that specifies the interval at which Atlas reports the metrics * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false - help for getDatabaseMeasurements * - --m - - m + - stringArray - false - - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. + - one or more types of measurement to request for this MongoDB process * - -o, --output - string - false @@ -85,19 +83,19 @@ Options * - --period - string - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. + - duration over which Atlas reports the metrics * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processId - - mongod + - string - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process * - --start - string - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. + - date and time when MongoDB Cloud begins reporting the metrics * - --version - string - false @@ -119,8 +117,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-monitoringAndLogs-getDatabaseMeasurements-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt deleted file mode 100644 index 650d607973..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ /dev/null @@ -1,143 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getDiskMeasurements: - -=============================================== -atlas api monitoringAndLogs getDiskMeasurements -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the measurements of one disk or partition for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Returned value can be one of the following: - - - -Throughput of I/O operations for the disk partition used for the MongoDB process - - -Percentage of time during which requests the partition issued and serviced - - -Latency per operation type of the disk partition used for the MongoDB process - - -Amount of free and used disk space on the disk partition used for the MongoDB process - - - -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-getdiskmeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getDiskMeasurements [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 - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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. - * - --granularity - - string - - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. - * - --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 getDiskMeasurements - * - --m - - m - - false - - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. - * - -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) - * - --partitionName - - string - - true - - Human-readable label of the disk or partition to which the measurements apply. - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --processId - - mongod - - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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-monitoringAndLogs-getDiskMeasurements-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getGroupProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getGroupProcess.txt new file mode 100644 index 0000000000..ec1b8e9d33 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-getGroupProcess.txt @@ -0,0 +1,102 @@ +.. _atlas-api-monitoringAndLogs-getGroupProcess: + +=========================================== +atlas api monitoringAndLogs getGroupProcess +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the processes for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocess. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs getGroupProcess [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 getGroupProcess + * - -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. + * - --processId + - mongod + - true + - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. + * - --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-monitoringAndLogs-getGroupProcess-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt deleted file mode 100644 index d22585853a..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getHostLogs: - -======================================= -atlas api monitoringAndLogs getHostLogs -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-gethostlogs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getHostLogs [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 - * - --endDate - - int - - false - - Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request. - * - --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 getHostLogs - * - --hostName - - string - - true - - Human-readable label that identifies the host that stores the log files that you want to download. - * - --logName - - string - - true - - Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project. - * - -o, --output - - string - - false - - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --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) - * - --startDate - - int - - false - - Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-01-01", "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-monitoringAndLogs-getHostLogs-2023-02-01-get_host_logs.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt deleted file mode 100644 index b933b77a91..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ /dev/null @@ -1,142 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getHostMeasurements: - -=============================================== -atlas api monitoringAndLogs getHostMeasurements -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns disk, partition, or host measurements per process for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Returned value can be one of the following: - - - -Throughput of I/O operations for the disk partition used for the MongoDB process - - -Percentage of time during which requests the partition issued and serviced - - -Latency per operation type of the disk partition used for the MongoDB process - - -Amount of free and used disk space on the disk partition used for the MongoDB process - - -Measurements for the host, such as CPU usage or number of I/O operations - - - -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-gethostmeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getHostMeasurements [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 - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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. - * - --granularity - - string - - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. - * - --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 getHostMeasurements - * - --m - - m - - false - - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --processId - - mongod - - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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-monitoringAndLogs-getHostMeasurements-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMeasurements.txt new file mode 100644 index 0000000000..df06e0f692 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMeasurements.txt @@ -0,0 +1,123 @@ +.. _atlas-api-monitoringAndLogs-getIndexMeasurements: + +================================================ +atlas api monitoringAndLogs getIndexMeasurements +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You must have the Project Read Only or higher role to view the Atlas Search metric types. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouphostftsmetricindexmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs getIndexMeasurements [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 + * - --collectionName + - string + - true + - human-readable label that identifies the collection + * - --databaseName + - string + - true + - human-readable label that identifies the database + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --granularity + - string + - true + - duration that specifies the interval at which Atlas reports the metrics + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getIndexMeasurements + * - --indexName + - string + - true + - human-readable label that identifies the index + * - --metrics + - stringArray + - true + - list that contains the measurements that MongoDB Atlas reports for the associated data series + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt deleted file mode 100644 index 74ab6265b8..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getIndexMetrics: - -=========================================== -atlas api monitoringAndLogs getIndexMetrics -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You must have the Project Read Only or higher role to view the Atlas Search metric types. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getindexmetrics. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getIndexMetrics [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 - * - --collectionName - - string - - true - - Human-readable label that identifies the collection. - * - --databaseName - - string - - true - - Human-readable label that identifies the database. - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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. - * - --granularity - - string - - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. - * - --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 getIndexMetrics - * - --indexName - - string - - true - - Human-readable label that identifies the index. - * - --metrics - - stringArray - - true - - List that contains the measurements that MongoDB Atlas reports for the associated data series. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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-monitoringAndLogs-getIndexMetrics-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt deleted file mode 100644 index a4235ea3fc..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-api-monitoringAndLogs-getMeasurements: - -=========================================== -atlas api monitoringAndLogs getMeasurements -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You must have the Project Read Only or higher role to view the Atlas Search metric types. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs getMeasurements [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 - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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. - * - --granularity - - string - - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. - * - --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 getMeasurements - * - --metrics - - stringArray - - true - - List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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-monitoringAndLogs-getMeasurements-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-getProcessDisk.txt b/docs/command/atlas-api-monitoringAndLogs-getProcessDisk.txt new file mode 100644 index 0000000000..a93bb58d76 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-getProcessDisk.txt @@ -0,0 +1,95 @@ +.. _atlas-api-monitoringAndLogs-getProcessDisk: + +========================================== +atlas api monitoringAndLogs getProcessDisk +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns measurement details for one disk or partition for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdisk. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs getProcessDisk [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getProcessDisk + * - -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) + * - --partitionName + - string + - true + - human-readable label of the disk or partition to which the measurements apply + * - --processId + - string + - true + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-getProcessDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getProcessDiskMeasurements.txt new file mode 100644 index 0000000000..b6e4424cc2 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-getProcessDiskMeasurements.txt @@ -0,0 +1,136 @@ +.. _atlas-api-monitoringAndLogs-getProcessDiskMeasurements: + +====================================================== +atlas api monitoringAndLogs getProcessDiskMeasurements +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the measurements of one disk or partition for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Returned value can be one of the following: + + + +Throughput of I/O operations for the disk partition used for the MongoDB process + + +Percentage of time during which requests the partition issued and serviced + + +Latency per operation type of the disk partition used for the MongoDB process + + +Amount of free and used disk space on the disk partition used for the MongoDB process + + + +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-getgroupprocessdiskmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs getProcessDiskMeasurements [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 + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --granularity + - string + - true + - duration that specifies the interval at which Atlas reports the metrics + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getProcessDiskMeasurements + * - --m + - stringArray + - false + - one or more types of measurement to request for this MongoDB process + * - -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) + * - --partitionName + - string + - true + - human-readable label of the disk or partition to which the measurements apply + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --processId + - string + - true + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-getProcessMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getProcessMeasurements.txt new file mode 100644 index 0000000000..28f083fc07 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-getProcessMeasurements.txt @@ -0,0 +1,135 @@ +.. _atlas-api-monitoringAndLogs-getProcessMeasurements: + +================================================== +atlas api monitoringAndLogs getProcessMeasurements +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns disk, partition, or host measurements per process for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Returned value can be one of the following: + + + +Throughput of I/O operations for the disk partition used for the MongoDB process + + +Percentage of time during which requests the partition issued and serviced + + +Latency per operation type of the disk partition used for the MongoDB process + + +Amount of free and used disk space on the disk partition used for the MongoDB process + + +Measurements for the host, such as CPU usage or number of I/O operations + + + +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-getgroupprocessmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs getProcessMeasurements [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 + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --granularity + - string + - true + - duration that specifies the interval at which Atlas reports the metrics + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getProcessMeasurements + * - --m + - stringArray + - false + - one or more types of measurement to request for this MongoDB process + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --processId + - string + - true + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt deleted file mode 100644 index 4ec55fa530..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-monitoringAndLogs-listAtlasProcesses: - -============================================== -atlas api monitoringAndLogs listAtlasProcesses -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details of all processes for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlasprocesses. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs listAtlasProcesses [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 listAtlasProcesses - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-monitoringAndLogs-listAtlasProcesses-2023-01-01-list_atlas_processes.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index e204d315bd..7f95011242 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabases. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessdatabases. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,11 +59,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -77,15 +75,15 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processId - - mongod + - string - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod). The port must be the IANA port on which the MongoDB process listens for requests. + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process * - --version - string - false @@ -107,8 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-monitoringAndLogs-listDatabases-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt deleted file mode 100644 index 735e296e46..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-monitoringAndLogs-listDiskMeasurements: - -================================================ -atlas api monitoringAndLogs listDiskMeasurements -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns measurement details for one disk or partition for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskmeasurements. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs listDiskMeasurements [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 listDiskMeasurements - * - -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) - * - --partitionName - - string - - true - - Human-readable label of the disk or partition to which the measurements apply. - * - --processId - - mongod - - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --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-monitoringAndLogs-listDiskMeasurements-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt deleted file mode 100644 index 0b1024627a..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-monitoringAndLogs-listDiskPartitions: - -============================================== -atlas api monitoringAndLogs listDiskPartitions -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the list of disks or partitions for the specified host for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskpartitions. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs listDiskPartitions [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 listDiskPartitions - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --processId - - mongod - - true - - Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --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-monitoringAndLogs-listDiskPartitions-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listGroupProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listGroupProcesses.txt new file mode 100644 index 0000000000..9b6cfdbb46 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-listGroupProcesses.txt @@ -0,0 +1,110 @@ +.. _atlas-api-monitoringAndLogs-listGroupProcesses: + +============================================== +atlas api monitoringAndLogs listGroupProcesses +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details of all processes for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocesses. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs listGroupProcesses [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 listGroupProcesses + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-monitoringAndLogs-listGroupProcesses-2023-01-01-list_atlas_processes.sh + :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listHostFtsMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listHostFtsMetrics.txt new file mode 100644 index 0000000000..9d7c4a1047 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-listHostFtsMetrics.txt @@ -0,0 +1,91 @@ +.. _atlas-api-monitoringAndLogs-listHostFtsMetrics: + +============================================== +atlas api monitoringAndLogs listHostFtsMetrics +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Search metric types available for one process in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You must have the Project Read Only or higher role to view the Atlas Search metric types. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetrics. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs listHostFtsMetrics [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listHostFtsMetrics + * - -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) + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMeasurements.txt new file mode 100644 index 0000000000..79f98d9c91 --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMeasurements.txt @@ -0,0 +1,117 @@ +.. _atlas-api-monitoringAndLogs-listIndexMeasurements: + +================================================= +atlas api monitoringAndLogs listIndexMeasurements +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgrouphostftsmetricindexmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs listIndexMeasurements [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 + * - --collectionName + - string + - true + - human-readable label that identifies the collection + * - --databaseName + - string + - true + - human-readable label that identifies the database + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --granularity + - string + - true + - duration that specifies the interval at which Atlas reports the metrics + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listIndexMeasurements + * - --metrics + - stringArray + - true + - list that contains the measurements that MongoDB Atlas reports for the associated data series + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt deleted file mode 100644 index 158b2a66cc..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ /dev/null @@ -1,124 +0,0 @@ -.. _atlas-api-monitoringAndLogs-listIndexMetrics: - -============================================ -atlas api monitoringAndLogs listIndexMetrics -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listindexmetrics. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs listIndexMetrics [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 - * - --collectionName - - string - - true - - Human-readable label that identifies the collection. - * - --databaseName - - string - - true - - Human-readable label that identifies the database. - * - --end - - string - - false - - Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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. - * - --granularity - - string - - true - - Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. - * - --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 listIndexMetrics - * - --metrics - - stringArray - - true - - List that contains the measurements that MongoDB Atlas reports for the associated data series. - * - -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) - * - --period - - string - - false - - Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --start - - string - - false - - Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. - * - --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-monitoringAndLogs-listIndexMetrics-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listMeasurements.txt new file mode 100644 index 0000000000..50230331bc --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-listMeasurements.txt @@ -0,0 +1,111 @@ +.. _atlas-api-monitoringAndLogs-listMeasurements: + +============================================ +atlas api monitoringAndLogs listMeasurements +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You must have the Project Read Only or higher role to view the Atlas Search metric types. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetricmeasurements. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs listMeasurements [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 + * - --end + - string + - false + - date and time when MongoDB Cloud stops reporting the metrics + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --granularity + - string + - true + - duration that specifies the interval at which Atlas reports the metrics + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listMeasurements + * - --metrics + - stringArray + - true + - list that contains the metrics that you want MongoDB Atlas to report for the associated data series + * - -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) + * - --period + - string + - false + - duration over which Atlas reports the metrics + * - --processId + - string + - true + - combination of hostname and IANA port that serves the MongoDB process + * - --start + - string + - false + - date and time when MongoDB Cloud begins reporting the metrics + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt deleted file mode 100644 index 03e0c837dc..0000000000 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-monitoringAndLogs-listMetricTypes: - -=========================================== -atlas api monitoringAndLogs listMetricTypes -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Atlas Search metric types available for one process in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You must have the Project Read Only or higher role to view the Atlas Search metric types. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listmetrictypes. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api monitoringAndLogs listMetricTypes [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 listMetricTypes - * - -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) - * - --processId - - string - - true - - Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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. - * - --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-monitoringAndLogs-listMetricTypes-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-monitoringAndLogs-listProcessDisks.txt b/docs/command/atlas-api-monitoringAndLogs-listProcessDisks.txt new file mode 100644 index 0000000000..18d5fdfcef --- /dev/null +++ b/docs/command/atlas-api-monitoringAndLogs-listProcessDisks.txt @@ -0,0 +1,107 @@ +.. _atlas-api-monitoringAndLogs-listProcessDisks: + +============================================ +atlas api monitoringAndLogs listProcessDisks +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the list of disks or partitions for the specified host for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessdisks. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api monitoringAndLogs listProcessDisks [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listProcessDisks + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --processId + - string + - true + - combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process + * - --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. + diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 5201c2aed6..75ccb2deee 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -54,37 +54,37 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-downloadClusterLog` - Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. * :ref:`atlas-api-monitoringAndLogs-getDatabase` - Returns one database running on the specified host for the specified project. * :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getGroupProcess` - Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMeasurements` - Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +* :ref:`atlas-api-monitoringAndLogs-getProcessDisk` - Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getProcessDiskMeasurements` - Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getProcessMeasurements` - Returns disk, partition, or host measurements per process for the specified host for the specified project. * :ref:`atlas-api-monitoringAndLogs-listDatabases` - Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listGroupProcesses` - Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listHostFtsMetrics` - Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMeasurements` - Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMeasurements` - Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listProcessDisks` - Returns the list of disks or partitions for the specified host for the specified project. .. toctree:: :titlesonly: - getAtlasProcess + downloadClusterLog getDatabase getDatabaseMeasurements - getDiskMeasurements - getHostLogs - getHostMeasurements - getIndexMetrics - getMeasurements - listAtlasProcesses + getGroupProcess + getIndexMeasurements + getProcessDisk + getProcessDiskMeasurements + getProcessMeasurements listDatabases - listDiskMeasurements - listDiskPartitions - listIndexMetrics - listMetricTypes + listGroupProcesses + listHostFtsMetrics + listIndexMeasurements + listMeasurements + listProcessDisks diff --git a/docs/command/atlas-api-networkPeering-createGroupContainer.txt b/docs/command/atlas-api-networkPeering-createGroupContainer.txt new file mode 100644 index 0000000000..ea4ba26cc8 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-createGroupContainer.txt @@ -0,0 +1,97 @@ +.. _atlas-api-networkPeering-createGroupContainer: + +============================================= +atlas api networkPeering createGroupContainer +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one new network peering container in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcontainer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering createGroupContainer [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupContainer + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-networkPeering-createGroupPeer.txt b/docs/command/atlas-api-networkPeering-createGroupPeer.txt new file mode 100644 index 0000000000..965e67afd4 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-createGroupPeer.txt @@ -0,0 +1,97 @@ +.. _atlas-api-networkPeering-createGroupPeer: + +======================================== +atlas api networkPeering createGroupPeer +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one new network peering connection in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategrouppeer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering createGroupPeer [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupPeer + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt deleted file mode 100644 index 5cac0abd18..0000000000 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-networkPeering-createPeeringConnection: - -================================================ -atlas api networkPeering createPeeringConnection -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one new network peering connection in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringconnection. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering createPeeringConnection [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createPeeringConnection - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt deleted file mode 100644 index d2d57d7c03..0000000000 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-networkPeering-createPeeringContainer: - -=============================================== -atlas api networkPeering createPeeringContainer -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one new network peering container in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringcontainer. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering createPeeringContainer [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createPeeringContainer - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-networkPeering-deleteGroupContainer.txt b/docs/command/atlas-api-networkPeering-deleteGroupContainer.txt new file mode 100644 index 0000000000..82b9ffa09d --- /dev/null +++ b/docs/command/atlas-api-networkPeering-deleteGroupContainer.txt @@ -0,0 +1,102 @@ +.. _atlas-api-networkPeering-deleteGroupContainer: + +============================================= +atlas api networkPeering deleteGroupContainer +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one network peering container in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcontainer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering deleteGroupContainer [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 + * - --containerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. + * - --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 deleteGroupContainer + * - -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. + * - --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-networkPeering-deleteGroupContainer-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-deleteGroupPeer.txt b/docs/command/atlas-api-networkPeering-deleteGroupPeer.txt new file mode 100644 index 0000000000..3e49ce6aaa --- /dev/null +++ b/docs/command/atlas-api-networkPeering-deleteGroupPeer.txt @@ -0,0 +1,102 @@ +.. _atlas-api-networkPeering-deleteGroupPeer: + +======================================== +atlas api networkPeering deleteGroupPeer +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one network peering connection in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegrouppeer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering deleteGroupPeer [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 deleteGroupPeer + * - -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) + * - --peerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-networkPeering-deleteGroupPeer-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt deleted file mode 100644 index 4f6d03660d..0000000000 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-networkPeering-deletePeeringConnection: - -================================================ -atlas api networkPeering deletePeeringConnection -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one network peering connection in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringconnection. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering deletePeeringConnection [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 deletePeeringConnection - * - -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) - * - --peerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-networkPeering-deletePeeringConnection-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt deleted file mode 100644 index 87c756da24..0000000000 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-networkPeering-deletePeeringContainer: - -=============================================== -atlas api networkPeering deletePeeringContainer -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one network peering container in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringcontainer. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering deletePeeringContainer [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 - * - --containerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. - * - --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 deletePeeringContainer - * - -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. - * - --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-networkPeering-deletePeeringContainer-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index f66f6e977f..11b3a7749c 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablepeering. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupprivateipmodepeering. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-networkPeering-getGroupContainer.txt b/docs/command/atlas-api-networkPeering-getGroupContainer.txt new file mode 100644 index 0000000000..5376a9af8f --- /dev/null +++ b/docs/command/atlas-api-networkPeering-getGroupContainer.txt @@ -0,0 +1,102 @@ +.. _atlas-api-networkPeering-getGroupContainer: + +========================================== +atlas api networkPeering getGroupContainer +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about one network peering container in one specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcontainer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering getGroupContainer [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 + * - --containerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container. + * - --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 getGroupContainer + * - -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. + * - --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-networkPeering-getGroupContainer-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-getGroupPeer.txt b/docs/command/atlas-api-networkPeering-getGroupPeer.txt new file mode 100644 index 0000000000..8db29cafbd --- /dev/null +++ b/docs/command/atlas-api-networkPeering-getGroupPeer.txt @@ -0,0 +1,102 @@ +.. _atlas-api-networkPeering-getGroupPeer: + +===================================== +atlas api networkPeering getGroupPeer +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about one specified network peering connection in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouppeer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering getGroupPeer [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 getGroupPeer + * - -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) + * - --peerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-networkPeering-getGroupPeer-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt deleted file mode 100644 index b6ccca58bb..0000000000 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-networkPeering-getPeeringConnection: - -============================================= -atlas api networkPeering getPeeringConnection -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about one specified network peering connection in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringconnection. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering getPeeringConnection [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 getPeeringConnection - * - -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) - * - --peerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-networkPeering-getPeeringConnection-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt deleted file mode 100644 index 34917e8ec0..0000000000 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-networkPeering-getPeeringContainer: - -============================================ -atlas api networkPeering getPeeringContainer -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about one network peering container in one specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringcontainer. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering getPeeringContainer [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 - * - --containerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container. - * - --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 getPeeringContainer - * - -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. - * - --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-networkPeering-getPeeringContainer-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-listGroupContainerAll.txt b/docs/command/atlas-api-networkPeering-listGroupContainerAll.txt new file mode 100644 index 0000000000..5c9b29c1bc --- /dev/null +++ b/docs/command/atlas-api-networkPeering-listGroupContainerAll.txt @@ -0,0 +1,110 @@ +.. _atlas-api-networkPeering-listGroupContainerAll: + +============================================== +atlas api networkPeering listGroupContainerAll +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about all network peering containers in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcontainerall. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering listGroupContainerAll [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 listGroupContainerAll + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-networkPeering-listGroupContainerAll-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-listGroupContainers.txt b/docs/command/atlas-api-networkPeering-listGroupContainers.txt new file mode 100644 index 0000000000..3e1f33c69a --- /dev/null +++ b/docs/command/atlas-api-networkPeering-listGroupContainers.txt @@ -0,0 +1,114 @@ +.. _atlas-api-networkPeering-listGroupContainers: + +============================================ +atlas api networkPeering listGroupContainers +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about all network peering containers in the specified project for the specified cloud provider. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcontainers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering listGroupContainers [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 listGroupContainers + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --providerName + - string + - true + - Cloud service provider that serves the desired network peering containers. + * - --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-networkPeering-listGroupContainers-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-listGroupPeers.txt b/docs/command/atlas-api-networkPeering-listGroupPeers.txt new file mode 100644 index 0000000000..15c65fdaa8 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-listGroupPeers.txt @@ -0,0 +1,114 @@ +.. _atlas-api-networkPeering-listGroupPeers: + +======================================= +atlas api networkPeering listGroupPeers +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about all network peering connections in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouppeers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering listGroupPeers [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 listGroupPeers + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --providerName + - string + - false + - Cloud service provider to use for this VPC peering connection. + * - --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-networkPeering-listGroupPeers-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt deleted file mode 100644 index 78a84abdd4..0000000000 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-networkPeering-listPeeringConnections: - -=============================================== -atlas api networkPeering listPeeringConnections -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about all network peering connections in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringconnections. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering listPeeringConnections [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 listPeeringConnections - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --providerName - - string - - false - - Cloud service provider to use for this VPC peering connection. - * - --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-networkPeering-listPeeringConnections-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt deleted file mode 100644 index ac92413e11..0000000000 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-networkPeering-listPeeringContainerByCloudProvider: - -============================================================ -atlas api networkPeering listPeeringContainerByCloudProvider -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about all network peering containers in the specified project for the specified cloud provider. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainerbycloudprovider. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering listPeeringContainerByCloudProvider [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 listPeeringContainerByCloudProvider - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --providerName - - string - - true - - Cloud service provider that serves the desired network peering containers. - * - --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-networkPeering-listPeeringContainerByCloudProvider-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt deleted file mode 100644 index 45af75c9cf..0000000000 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-networkPeering-listPeeringContainers: - -============================================== -atlas api networkPeering listPeeringContainers -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about all network peering containers in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainers. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering listPeeringContainers [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 listPeeringContainers - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-networkPeering-listPeeringContainers-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-updateGroupContainer.txt b/docs/command/atlas-api-networkPeering-updateGroupContainer.txt new file mode 100644 index 0000000000..0cb9873441 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-updateGroupContainer.txt @@ -0,0 +1,101 @@ +.. _atlas-api-networkPeering-updateGroupContainer: + +============================================= +atlas api networkPeering updateGroupContainer +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the network details and labels of one specified network peering container in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcontainer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering updateGroupContainer [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 + * - --containerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupContainer + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-networkPeering-updateGroupPeer.txt b/docs/command/atlas-api-networkPeering-updateGroupPeer.txt new file mode 100644 index 0000000000..ac454c8631 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-updateGroupPeer.txt @@ -0,0 +1,101 @@ +.. _atlas-api-networkPeering-updateGroupPeer: + +======================================== +atlas api networkPeering updateGroupPeer +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one specified network peering connection in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategrouppeer. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering updateGroupPeer [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupPeer + * - -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) + * - --peerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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. + diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt deleted file mode 100644 index 5a92893648..0000000000 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-networkPeering-updatePeeringConnection: - -================================================ -atlas api networkPeering updatePeeringConnection -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one specified network peering connection in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringconnection. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering updatePeeringConnection [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updatePeeringConnection - * - -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) - * - --peerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt deleted file mode 100644 index 950ea9c8da..0000000000 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-networkPeering-updatePeeringContainer: - -=============================================== -atlas api networkPeering updatePeeringContainer -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the network details and labels of one specified network peering container in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringcontainer. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering updatePeeringContainer [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 - * - --containerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updatePeeringContainer - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt deleted file mode 100644 index 176edc1361..0000000000 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject: - -===================================================================== -atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject -===================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Verifies if someone set the specified project to Connect via Peering Only mode. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyconnectviapeeringonlymodeforoneproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject [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 verifyConnectViaPeeringOnlyModeForOneProject - * - -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. - * - --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-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-networkPeering-verifyPrivateIpMode.txt b/docs/command/atlas-api-networkPeering-verifyPrivateIpMode.txt new file mode 100644 index 0000000000..39dcb31f08 --- /dev/null +++ b/docs/command/atlas-api-networkPeering-verifyPrivateIpMode.txt @@ -0,0 +1,91 @@ +.. _atlas-api-networkPeering-verifyPrivateIpMode: + +============================================ +atlas api networkPeering verifyPrivateIpMode +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Verifies if someone set the specified project to Connect via Peering Only mode. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifygroupprivateipmode. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api networkPeering verifyPrivateIpMode [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for verifyPrivateIpMode + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index dc2b326588..2caf9e6a58 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -54,35 +54,35 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-createGroupContainer` - Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-createGroupPeer` - Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deleteGroupContainer` - Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deleteGroupPeer` - Removes one network peering connection in the specified project. * :ref:`atlas-api-networkPeering-disablePeering` - Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-getGroupContainer` - Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-getGroupPeer` - Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-listGroupContainerAll` - Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-listGroupContainers` - Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listGroupPeers` - Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-updateGroupContainer` - Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-updateGroupPeer` - Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-verifyPrivateIpMode` - Verifies if someone set the specified project to Connect via Peering Only mode. .. toctree:: :titlesonly: - createPeeringConnection - createPeeringContainer - deletePeeringConnection - deletePeeringContainer + createGroupContainer + createGroupPeer + deleteGroupContainer + deleteGroupPeer disablePeering - getPeeringConnection - getPeeringContainer - listPeeringConnections - listPeeringContainerByCloudProvider - listPeeringContainers - updatePeeringConnection - updatePeeringContainer - verifyConnectViaPeeringOnlyModeForOneProject + getGroupContainer + getGroupPeer + listGroupContainerAll + listGroupContainers + listGroupPeers + updateGroupContainer + updateGroupPeer + verifyPrivateIpMode diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index 3a640d5003..e0e6c02782 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusteronlinearchive. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive. + - human-readable label that identifies the cluster that contains the collection for which you want to create one online archive * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 2b5c9e9817..557c98f6eb 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusteronlinearchive. For more information and examples, see the referenced API documentation linked above. @@ -47,21 +47,19 @@ Options * - --archiveId - string - true - - Unique 24-hexadecimal digit string that identifies the online archive to delete. + - unique 24-hexadecimal digit string that identifies the online archive to delete * - --clusterName - string - true - - Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. + - human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -107,8 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-onlineArchive-deleteOnlineArchive-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt deleted file mode 100644 index 7405f7e0d6..0000000000 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs: - -====================================================== -atlas api onlineArchive downloadOnlineArchiveQueryLogs -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Downloads query logs for the specified online archive. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadonlinearchivequerylogs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api onlineArchive downloadOnlineArchiveQueryLogs [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 - * - --archiveOnly - - - - false - - Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. - * - --clusterName - - string - - true - - Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive. - * - --endDate - - int - - false - - Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - * - --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 downloadOnlineArchiveQueryLogs - * - -o, --output - - string - - false - - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --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) - * - --startDate - - int - - false - - Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - * - --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-onlineArchive-downloadOnlineArchiveQueryLogs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-onlineArchive-downloadQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadQueryLogs.txt new file mode 100644 index 0000000000..916745ae03 --- /dev/null +++ b/docs/command/atlas-api-onlineArchive-downloadQueryLogs.txt @@ -0,0 +1,103 @@ +.. _atlas-api-onlineArchive-downloadQueryLogs: + +========================================= +atlas api onlineArchive downloadQueryLogs +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Downloads query logs for the specified online archive. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusteronlinearchivequerylogs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api onlineArchive downloadQueryLogs [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 + * - --archiveOnly + - + - false + - flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster + * - --clusterName + - string + - true + - human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive + * - --endDate + - int + - false + - date and time that specifies the end point for the range of log messages to return + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for downloadQueryLogs + * - -o, --output + - string + - false + - preferred api format, can be ["gzip"] This value defaults to "gzip". + * - --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) + * - --startDate + - int + - false + - date and time that specifies the starting point for the range of log messages to return + * - --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. + diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 3e80241006..cf16db0f2a 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusteronlinearchive. For more information and examples, see the referenced API documentation linked above. @@ -47,21 +47,19 @@ Options * - --archiveId - string - true - - Unique 24-hexadecimal digit string that identifies the online archive to return. + - unique 24-hexadecimal digit string that identifies the online archive to return * - --clusterName - string - true - - Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. + - human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-onlineArchive-getOnlineArchive-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 4404520af5..f27373653c 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listonlinearchives. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusteronlinearchives. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives. + - human-readable label that identifies the cluster that contains the collection for which you want to return the online archives * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -65,11 +63,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -81,11 +79,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -107,8 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-onlineArchive-listOnlineArchives-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 18d6eebccd..6e0f27a03c 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusteronlinearchive. For more information and examples, see the referenced API documentation linked above. @@ -47,15 +47,15 @@ Options * - --archiveId - string - true - - Unique 24-hexadecimal digit string that identifies the online archive to update. + - unique 24-hexadecimal digit string that identifies the online archive to update * - --clusterName - string - true - - Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. + - human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -63,9 +63,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -81,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index ea95db3e4e..cd2944ca07 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -56,7 +56,7 @@ Related Commands * :ref:`atlas-api-onlineArchive-createOnlineArchive` - Creates one online archive. * :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-downloadQueryLogs` - Downloads query logs for the specified online archive. * :ref:`atlas-api-onlineArchive-getOnlineArchive` - Returns one online archive for one cluster. * :ref:`atlas-api-onlineArchive-listOnlineArchives` - Returns details of all online archives. * :ref:`atlas-api-onlineArchive-updateOnlineArchive` - Updates, pauses, or resumes one online archive. @@ -67,7 +67,7 @@ Related Commands createOnlineArchive deleteOnlineArchive - downloadOnlineArchiveQueryLogs + downloadQueryLogs getOnlineArchive listOnlineArchives updateOnlineArchive diff --git a/docs/command/atlas-api-organizations-createOrg.txt b/docs/command/atlas-api-organizations-createOrg.txt new file mode 100644 index 0000000000..18e9ff829b --- /dev/null +++ b/docs/command/atlas-api-organizations-createOrg.txt @@ -0,0 +1,91 @@ +.. _atlas-api-organizations-createOrg: + +================================= +atlas api organizations createOrg +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorg. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations createOrg [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrg + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-createOrgInvite.txt b/docs/command/atlas-api-organizations-createOrgInvite.txt new file mode 100644 index 0000000000..7d7c1d017d --- /dev/null +++ b/docs/command/atlas-api-organizations-createOrgInvite.txt @@ -0,0 +1,98 @@ +.. _atlas-api-organizations-createOrgInvite: + +======================================= +atlas api organizations createOrgInvite +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invites one MongoDB Cloud user to join the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorginvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations createOrgInvite [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgInvite + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt deleted file mode 100644 index 06bd3e8da9..0000000000 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-api-organizations-createOrganization: - -========================================== -atlas api organizations createOrganization -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganization. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations createOrganization [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createOrganization - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt deleted file mode 100644 index 3b35905b67..0000000000 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-organizations-createOrganizationInvitation: - -==================================================== -atlas api organizations createOrganizationInvitation -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invites one MongoDB Cloud user to join the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganizationinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations createOrganizationInvitation [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createOrganizationInvitation - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations-deleteOrg.txt b/docs/command/atlas-api-organizations-deleteOrg.txt new file mode 100644 index 0000000000..0224e84eb4 --- /dev/null +++ b/docs/command/atlas-api-organizations-deleteOrg.txt @@ -0,0 +1,100 @@ +.. _atlas-api-organizations-deleteOrg: + +================================= +atlas api organizations deleteOrg +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB Cloud imposes the following limits on this resource: + + + +Organizations with active projects cannot be removed. + + +All projects in the organization must be removed before you can remove the organization. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorg. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations deleteOrg [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. + * - -h, --help + - + - false + - help for deleteOrg + * - --orgId + - string + - true + - 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. + * - -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) + * - --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-organizations-deleteOrg-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-deleteOrgInvite.txt b/docs/command/atlas-api-organizations-deleteOrgInvite.txt new file mode 100644 index 0000000000..82ce898bc5 --- /dev/null +++ b/docs/command/atlas-api-organizations-deleteOrgInvite.txt @@ -0,0 +1,103 @@ +.. _atlas-api-organizations-deleteOrgInvite: + +======================================= +atlas api organizations deleteOrgInvite +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorginvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations deleteOrgInvite [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. + * - -h, --help + - + - false + - help for deleteOrgInvite + * - --invitationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the invitation. + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-organizations-deleteOrgInvite-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt deleted file mode 100644 index 07c83978e9..0000000000 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-organizations-deleteOrganization: - -========================================== -atlas api organizations deleteOrganization -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB Cloud imposes the following limits on this resource: - - - -Organizations with active projects cannot be removed. - - -All projects in the organization must be removed before you can remove the organization. -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorganization. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations deleteOrganization [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. - * - -h, --help - - - - false - - help for deleteOrganization - * - --orgId - - string - - true - - 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. - * - -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) - * - --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-organizations-deleteOrganization-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt deleted file mode 100644 index b9d46c3e5a..0000000000 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-api-organizations-deleteOrganizationInvitation: - -==================================================== -atlas api organizations deleteOrganizationInvitation -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorganizationinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations deleteOrganizationInvitation [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. - * - -h, --help - - - - false - - help for deleteOrganizationInvitation - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-organizations-deleteOrganizationInvitation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-getOrg.txt b/docs/command/atlas-api-organizations-getOrg.txt new file mode 100644 index 0000000000..05c6216ffa --- /dev/null +++ b/docs/command/atlas-api-organizations-getOrg.txt @@ -0,0 +1,96 @@ +.. _atlas-api-organizations-getOrg: + +============================== +atlas api organizations getOrg +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one organization to which the requesting Service Account or API Key has access. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorg. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations getOrg [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. + * - -h, --help + - + - false + - help for getOrg + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-organizations-getOrg-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-getOrgGroups.txt b/docs/command/atlas-api-organizations-getOrgGroups.txt new file mode 100644 index 0000000000..1ec4f9b11a --- /dev/null +++ b/docs/command/atlas-api-organizations-getOrgGroups.txt @@ -0,0 +1,129 @@ +.. _atlas-api-organizations-getOrgGroups: + +==================================== +atlas api organizations getOrgGroups +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns multiple projects in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Each organization can have multiple projects. Use projects to: + + + +Isolate different environments, such as development, test, or production environments, from each other. + + +Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments. + + +Maintain separate cluster security configurations. + + +Create different alert 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-getorggroups. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations getOrgGroups [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. + * - -h, --help + - + - false + - help for getOrgGroups + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --name + - string + - false + - Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. + * - --orgId + - string + - true + - 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. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-organizations-getOrgGroups-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-getOrgInvite.txt b/docs/command/atlas-api-organizations-getOrgInvite.txt new file mode 100644 index 0000000000..4b248fb156 --- /dev/null +++ b/docs/command/atlas-api-organizations-getOrgInvite.txt @@ -0,0 +1,99 @@ +.. _atlas-api-organizations-getOrgInvite: + +==================================== +atlas api organizations getOrgInvite +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of one pending invitation to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations getOrgInvite [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. + * - -h, --help + - + - false + - help for getOrgInvite + * - --invitationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the invitation. + * - --orgId + - string + - true + - 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. + * - -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) + * - --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-organizations-getOrgInvite-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-getOrgSettings.txt b/docs/command/atlas-api-organizations-getOrgSettings.txt new file mode 100644 index 0000000000..d7d2075955 --- /dev/null +++ b/docs/command/atlas-api-organizations-getOrgSettings.txt @@ -0,0 +1,96 @@ +.. _atlas-api-organizations-getOrgSettings: + +====================================== +atlas api organizations getOrgSettings +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the specified organization's settings. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgsettings. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations getOrgSettings [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. + * - -h, --help + - + - false + - help for getOrgSettings + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-organizations-getOrgSettings-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt deleted file mode 100644 index 0adf0ab304..0000000000 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-organizations-getOrganization: - -======================================= -atlas api organizations getOrganization -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one organization to which the requesting Service Account or API Key has access. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganization. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations getOrganization [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. - * - -h, --help - - - - false - - help for getOrganization - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-organizations-getOrganization-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt deleted file mode 100644 index 65f773758c..0000000000 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-organizations-getOrganizationInvitation: - -================================================= -atlas api organizations getOrganizationInvitation -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of one pending invitation to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations getOrganizationInvitation [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. - * - -h, --help - - - - false - - help for getOrganizationInvitation - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - --orgId - - string - - true - - 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. - * - -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) - * - --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-organizations-getOrganizationInvitation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt deleted file mode 100644 index 6330c6cdaa..0000000000 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-organizations-getOrganizationSettings: - -=============================================== -atlas api organizations getOrganizationSettings -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the specified organization's settings. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations getOrganizationSettings [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. - * - -h, --help - - - - false - - help for getOrganizationSettings - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-organizations-getOrganizationSettings-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-listOrgInvites.txt b/docs/command/atlas-api-organizations-listOrgInvites.txt new file mode 100644 index 0000000000..0bffea3d67 --- /dev/null +++ b/docs/command/atlas-api-organizations-listOrgInvites.txt @@ -0,0 +1,103 @@ +.. _atlas-api-organizations-listOrgInvites: + +====================================== +atlas api organizations listOrgInvites +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all pending invitations to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvites. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations listOrgInvites [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. + * - -h, --help + - + - false + - help for listOrgInvites + * - --orgId + - string + - true + - 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. + * - -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. + * - --username + - string + - false + - Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations. + * - --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-organizations-listOrgInvites-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt deleted file mode 100644 index 019e106ca9..0000000000 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-api-organizations-listOrganizationInvitations: - -=================================================== -atlas api organizations listOrganizationInvitations -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all pending invitations to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationinvitations. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations listOrganizationInvitations [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. - * - -h, --help - - - - false - - help for listOrganizationInvitations - * - --orgId - - string - - true - - 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. - * - -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. - * - --username - - string - - false - - Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations. - * - --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-organizations-listOrganizationInvitations-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt deleted file mode 100644 index c1fa9cf9f8..0000000000 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ /dev/null @@ -1,129 +0,0 @@ -.. _atlas-api-organizations-listOrganizationProjects: - -================================================ -atlas api organizations listOrganizationProjects -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns multiple projects in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Each organization can have multiple projects. Use projects to: - - - -Isolate different environments, such as development, test, or production environments, from each other. - - -Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments. - - -Maintain separate cluster security configurations. - - -Create different alert 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-listorganizationprojects. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations listOrganizationProjects [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. - * - -h, --help - - - - false - - help for listOrganizationProjects - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --name - - string - - false - - Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-organizations-listOrganizationProjects-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt deleted file mode 100644 index d602c2c565..0000000000 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-api-organizations-listOrganizations: - -========================================= -atlas api organizations listOrganizations -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all organizations to which the requesting Service Account or API Key has access. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizations. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations listOrganizations [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. - * - -h, --help - - - - false - - help for listOrganizations - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --name - - string - - false - - Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-organizations-listOrgs.txt b/docs/command/atlas-api-organizations-listOrgs.txt new file mode 100644 index 0000000000..c70eee7bc7 --- /dev/null +++ b/docs/command/atlas-api-organizations-listOrgs.txt @@ -0,0 +1,103 @@ +.. _atlas-api-organizations-listOrgs: + +================================ +atlas api organizations listOrgs +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all organizations to which the requesting Service Account or API Key has access. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations listOrgs [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. + * - -h, --help + - + - false + - help for listOrgs + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --name + - string + - false + - Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrg.txt b/docs/command/atlas-api-organizations-updateOrg.txt new file mode 100644 index 0000000000..1d950fc3e2 --- /dev/null +++ b/docs/command/atlas-api-organizations-updateOrg.txt @@ -0,0 +1,95 @@ +.. _atlas-api-organizations-updateOrg: + +================================= +atlas api organizations updateOrg +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorg. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations updateOrg [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrg + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrgInviteById.txt b/docs/command/atlas-api-organizations-updateOrgInviteById.txt new file mode 100644 index 0000000000..2253109ce9 --- /dev/null +++ b/docs/command/atlas-api-organizations-updateOrgInviteById.txt @@ -0,0 +1,99 @@ +.. _atlas-api-organizations-updateOrgInviteById: + +=========================================== +atlas api organizations updateOrgInviteById +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the details of one pending invitation, identified by its unique ID, to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorginvitebyid. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations updateOrgInviteById [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgInviteById + * - --invitationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the invitation. + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrgInvites.txt b/docs/command/atlas-api-organizations-updateOrgInvites.txt new file mode 100644 index 0000000000..8e42c21583 --- /dev/null +++ b/docs/command/atlas-api-organizations-updateOrgInvites.txt @@ -0,0 +1,95 @@ +.. _atlas-api-organizations-updateOrgInvites: + +======================================== +atlas api organizations updateOrgInvites +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorginvites. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations updateOrgInvites [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgInvites + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrgSettings.txt b/docs/command/atlas-api-organizations-updateOrgSettings.txt new file mode 100644 index 0000000000..39984b24b0 --- /dev/null +++ b/docs/command/atlas-api-organizations-updateOrgSettings.txt @@ -0,0 +1,95 @@ +.. _atlas-api-organizations-updateOrgSettings: + +========================================= +atlas api organizations updateOrgSettings +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the organization's settings. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgsettings. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations updateOrgSettings [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgSettings + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrgUserRoles.txt b/docs/command/atlas-api-organizations-updateOrgUserRoles.txt new file mode 100644 index 0000000000..71de44b22c --- /dev/null +++ b/docs/command/atlas-api-organizations-updateOrgUserRoles.txt @@ -0,0 +1,99 @@ +.. _atlas-api-organizations-updateOrgUserRoles: + +========================================== +atlas api organizations updateOrgUserRoles +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the roles of the specified user in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorguserroles. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api organizations updateOrgUserRoles [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgUserRoles + * - --orgId + - string + - true + - 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. + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the user to modify. + * - --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. + diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt deleted file mode 100644 index 9c78322dee..0000000000 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-organizations-updateOrganization: - -========================================== -atlas api organizations updateOrganization -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganization. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations updateOrganization [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganization - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt deleted file mode 100644 index 042e859321..0000000000 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-organizations-updateOrganizationInvitation: - -==================================================== -atlas api organizations updateOrganizationInvitation -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations updateOrganizationInvitation [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganizationInvitation - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt deleted file mode 100644 index e33350b548..0000000000 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-organizations-updateOrganizationInvitationById: - -======================================================== -atlas api organizations updateOrganizationInvitationById -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the details of one pending invitation, identified by its unique ID, to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitationbyid. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations updateOrganizationInvitationById [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganizationInvitationById - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt deleted file mode 100644 index dbe7f74374..0000000000 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-organizations-updateOrganizationRoles: - -=============================================== -atlas api organizations updateOrganizationRoles -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the roles of the specified user in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationroles. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations updateOrganizationRoles [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganizationRoles - * - --orgId - - string - - true - - 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. - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the user to modify. - * - --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. - diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt deleted file mode 100644 index 3eed6e3c7b..0000000000 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-organizations-updateOrganizationSettings: - -================================================== -atlas api organizations updateOrganizationSettings -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the organization's settings. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api organizations updateOrganizationSettings [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateOrganizationSettings - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index b87afb10d9..ce36dbf9b3 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -54,39 +54,39 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - Returns one organization to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - Returns all organizations to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-updateOrganization` - Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - Updates the details of one pending invitation, identified by its unique ID, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrg` - Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +* :ref:`atlas-api-organizations-createOrgInvite` - Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrg` - Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrgInvite` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrg` - Returns one organization to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-getOrgGroups` - Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-getOrgInvite` - Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrgSettings` - Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrgInvites` - Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrgs` - Returns all organizations to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-updateOrg` - Updates one organization. +* :ref:`atlas-api-organizations-updateOrgInviteById` - Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +* :ref:`atlas-api-organizations-updateOrgInvites` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +* :ref:`atlas-api-organizations-updateOrgSettings` - Updates the organization's settings. +* :ref:`atlas-api-organizations-updateOrgUserRoles` - Updates the roles of the specified user in the specified organization. .. toctree:: :titlesonly: - createOrganization - createOrganizationInvitation - deleteOrganization - deleteOrganizationInvitation - getOrganization - getOrganizationInvitation - getOrganizationSettings - listOrganizationInvitations - listOrganizationProjects - listOrganizations - updateOrganization - updateOrganizationInvitation - updateOrganizationInvitationById - updateOrganizationRoles - updateOrganizationSettings + createOrg + createOrgInvite + deleteOrg + deleteOrgInvite + getOrg + getOrgGroups + getOrgInvite + getOrgSettings + listOrgInvites + listOrgs + updateOrg + updateOrgInviteById + updateOrgInvites + updateOrgSettings + updateOrgUserRoles diff --git a/docs/command/atlas-api-performanceAdvisor-disableManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-disableManagedSlowMs.txt new file mode 100644 index 0000000000..463c185d8e --- /dev/null +++ b/docs/command/atlas-api-performanceAdvisor-disableManagedSlowMs.txt @@ -0,0 +1,91 @@ +.. _atlas-api-performanceAdvisor-disableManagedSlowMs: + +================================================= +atlas api performanceAdvisor disableManagedSlowMs +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupmanagedslowms. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api performanceAdvisor disableManagedSlowMs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for disableManagedSlowMs + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt deleted file mode 100644 index 6f03a1de12..0000000000 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-performanceAdvisor-disableSlowOperationThresholding: - -============================================================= -atlas api performanceAdvisor disableSlowOperationThresholding -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disableslowoperationthresholding. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api performanceAdvisor disableSlowOperationThresholding [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 disableSlowOperationThresholding - * - -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. - * - --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-performanceAdvisor-disableSlowOperationThresholding-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-enableManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-enableManagedSlowMs.txt new file mode 100644 index 0000000000..34f4151564 --- /dev/null +++ b/docs/command/atlas-api-performanceAdvisor-enableManagedSlowMs.txt @@ -0,0 +1,91 @@ +.. _atlas-api-performanceAdvisor-enableManagedSlowMs: + +================================================ +atlas api performanceAdvisor enableManagedSlowMs +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enables MongoDB Cloud to use its slow operation threshold for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-enablegroupmanagedslowms. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api performanceAdvisor enableManagedSlowMs [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for enableManagedSlowMs + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt deleted file mode 100644 index 7fd3cc2f70..0000000000 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-performanceAdvisor-enableSlowOperationThresholding: - -============================================================ -atlas api performanceAdvisor enableSlowOperationThresholding -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enables MongoDB Cloud to use its slow operation threshold for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-enableslowoperationthresholding. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api performanceAdvisor enableSlowOperationThresholding [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 enableSlowOperationThresholding - * - -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. - * - --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-performanceAdvisor-enableSlowOperationThresholding-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index bfc7f73294..f423b08512 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -17,7 +17,7 @@ Get whether the Managed Slow MS feature is enabled. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmanagedslowms. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupmanagedslowms. For more information and examples, see the referenced API documentation linked above. @@ -43,15 +43,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -67,7 +65,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -89,8 +87,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-getManagedSlowMs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 45b231f46a..127cdbadae 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessautoindexing. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessperformanceadvisorautoindexing. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-getServerlessAutoIndexing-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 10c02a0e12..6c97e69b2d 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersuggestedindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisorsuggestedindexes. For more information and examples, see the referenced API documentation linked above. @@ -47,21 +47,19 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - human-readable label that identifies the cluster * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false - help for listClusterSuggestedIndexes * - --namespaces - - . + - stringArray - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + - namespaces from which to retrieve suggested indexes * - -o, --output - string - false @@ -71,23 +69,17 @@ Options - 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) * - --processIds - - mongod + - stringArray - false - - ProcessIds from which to retrieve suggested indexes. 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. + - processIds from which to retrieve suggested indexes * - --since - int - false - - Date and time from which the query retrieves the suggested indexes. 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. + - date and time from which the query retrieves the suggested indexes * - --until - int - false - - Date and time up until which the query retrieves the suggested indexes. 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. + - date and time up until which the query retrieves the suggested indexes * - --version - string - false @@ -109,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-listClusterSuggestedIndexes-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexSuggestions.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexSuggestions.txt new file mode 100644 index 0000000000..7a82497303 --- /dev/null +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexSuggestions.txt @@ -0,0 +1,87 @@ +.. _atlas-api-performanceAdvisor-listDropIndexSuggestions: + +===================================================== +atlas api performanceAdvisor listDropIndexSuggestions +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the indexes that the Performance Advisor suggests to drop. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisordropindexsuggestions. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api performanceAdvisor listDropIndexSuggestions [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 + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listDropIndexSuggestions + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt deleted file mode 100644 index db1889b183..0000000000 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-api-performanceAdvisor-listDropIndexes: - -============================================ -atlas api performanceAdvisor listDropIndexes -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the indexes that the Performance Advisor suggests to drop. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdropindexes. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api performanceAdvisor listDropIndexes [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. - * - --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 listDropIndexes - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-performanceAdvisor-listDropIndexes-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listPerformanceAdvisorNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listPerformanceAdvisorNamespaces.txt new file mode 100644 index 0000000000..3a489bb059 --- /dev/null +++ b/docs/command/atlas-api-performanceAdvisor-listPerformanceAdvisorNamespaces.txt @@ -0,0 +1,103 @@ +.. _atlas-api-performanceAdvisor-listPerformanceAdvisorNamespaces: + +============================================================= +atlas api performanceAdvisor listPerformanceAdvisorNamespaces +============================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns up to 20 namespaces for collections experiencing slow queries on the specified host. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisornamespaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api performanceAdvisor listPerformanceAdvisorNamespaces [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 + * - --duration + - int + - false + - length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listPerformanceAdvisorNamespaces + * - -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 + * - --processId + - string + - true + - combination of host and port that serves the MongoDB process + * - --since + - int + - false + - date and time from which the query retrieves the suggested indexes + * - --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. + diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 093b4d007d..2b468c3508 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listschemaadvice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisorschemaadvice. For more information and examples, see the referenced API documentation linked above. @@ -47,13 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - human-readable label that identifies the cluster * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -87,8 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-listSchemaAdvice-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt deleted file mode 100644 index 605b73a2be..0000000000 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ /dev/null @@ -1,136 +0,0 @@ -.. _atlas-api-performanceAdvisor-listSlowQueries: - -============================================ -atlas api performanceAdvisor listSlowQueries -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowqueries. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api performanceAdvisor listSlowQueries [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 - * - --duration - - int - - false - - Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - - - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. - * - --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 listSlowQueries - * - --includeMetrics - - - - false - - Whether or not to include metrics extracted from the slow query log as separate fields. - * - --includeOpType - - - - false - - Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field. - * - --includeReplicaState - - - - false - - Whether or not to include the replica state of the host when the slow query log was generated as a separate field. - * - --nLogs - - int - - false - - Maximum number of lines from the log to return. - * - --namespaces - - . - - false - - Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. - * - -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. - * - --processId - - mongod - - true - - 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. - * - --since - - int - - false - - Date and time from which the query retrieves the slow queries. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. - * - --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-performanceAdvisor-listSlowQueries-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryLogs.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryLogs.txt new file mode 100644 index 0000000000..58a16fb0fb --- /dev/null +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryLogs.txt @@ -0,0 +1,123 @@ +.. _atlas-api-performanceAdvisor-listSlowQueryLogs: + +============================================== +atlas api performanceAdvisor listSlowQueryLogs +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisorslowquerylogs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api performanceAdvisor listSlowQueryLogs [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 + * - --duration + - int + - false + - length of time expressed during which the query finds slow queries among the managed namespaces in the cluster + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listSlowQueryLogs + * - --includeMetrics + - + - false + - whether or not to include metrics extracted from the slow query log as separate fields + * - --includeOpType + - + - false + - whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field + * - --includeReplicaState + - + - false + - whether or not to include the replica state of the host when the slow query log was generated as a separate field + * - --nLogs + - int + - false + - maximum number of lines from the log to return + * - --namespaces + - stringArray + - false + - namespaces from which to retrieve slow queries + * - -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 + * - --processId + - string + - true + - combination of host and port that serves the MongoDB process + * - --since + - int + - false + - date and time from which the query retrieves the slow queries + * - --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. + diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt deleted file mode 100644 index 1aee593136..0000000000 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ /dev/null @@ -1,116 +0,0 @@ -.. _atlas-api-performanceAdvisor-listSlowQueryNamespaces: - -==================================================== -atlas api performanceAdvisor listSlowQueryNamespaces -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns up to 20 namespaces for collections experiencing slow queries on the specified host. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowquerynamespaces. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api performanceAdvisor listSlowQueryNamespaces [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 - * - --duration - - int - - false - - Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - - - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. - * - --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 listSlowQueryNamespaces - * - -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. - * - --processId - - mongod - - true - - 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. - * - --since - - int - - false - - Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. - * - --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-performanceAdvisor-listSlowQueryNamespaces-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 10ee71066f..8a55f9f9c7 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsuggestedindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisorsuggestedindexes. For more information and examples, see the referenced API documentation linked above. @@ -47,20 +47,15 @@ Options * - --duration - int - false - - Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - - - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. + - length of time expressed during which the query finds suggested indexes among the managed namespaces in 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -68,23 +63,23 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - --nExamples - int - false - - Maximum number of example queries that benefit from the suggested index. + - maximum number of example queries that benefit from the suggested index * - --nIndexes - int - false - - Number that indicates the maximum indexes to suggest. + - number that indicates the maximum indexes to suggest * - --namespaces - - . + - stringArray - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + - namespaces from which to retrieve suggested indexes * - -o, --output - string - false @@ -96,22 +91,19 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processId - - mongod + - string - true - - 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. + - combination of host and port that serves the MongoDB process * - --since - int - false - - Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. + - date and time from which the query retrieves the suggested indexes * - --version - string - false @@ -133,8 +125,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-listSuggestedIndexes-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index ea5d341e6a..b5063cf08f 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setserverlessautoindexing. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgroupserverlessperformanceadvisorautoindexing. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster. + - human-readable label that identifies the cluster * - --enable - - true - - Value that we want to set for the Serverless Auto Indexing toggle. + - value that we want to set for the Serverless Auto Indexing toggle * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-performanceAdvisor-setServerlessAutoIndexing-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index ac792e2593..7fdcd379d5 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -54,15 +54,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-disableManagedSlowMs` - Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableManagedSlowMs` - Enables MongoDB Cloud to use its slow operation threshold for the specified project. * :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - Get whether the Managed Slow MS feature is enabled. * :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - Get whether the Serverless Auto Indexing feature is enabled. * :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listDropIndexSuggestions` - Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listPerformanceAdvisorNamespaces` - Returns up to 20 namespaces for collections experiencing slow queries on the specified host. * :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryLogs` - Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. * :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. * :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - Set whether the Serverless Auto Indexing feature is enabled. @@ -70,15 +70,15 @@ Related Commands .. toctree:: :titlesonly: - disableSlowOperationThresholding - enableSlowOperationThresholding + disableManagedSlowMs + enableManagedSlowMs getManagedSlowMs getServerlessAutoIndexing listClusterSuggestedIndexes - listDropIndexes + listDropIndexSuggestions + listPerformanceAdvisorNamespaces listSchemaAdvice - listSlowQueries - listSlowQueryNamespaces + listSlowQueryLogs listSuggestedIndexes setServerlessAutoIndexing diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index f4f3cf17a0..9b63c40358 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointendpointserviceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -47,15 +47,15 @@ Options * - --cloudProvider - string - true - - Cloud service provider that manages this private endpoint. + - cloud service provider that manages this private endpoint * - --endpointServiceId - string - true - - Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. + - unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -63,9 +63,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -81,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 81d2748b19..6e58c784b8 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointendpointservice. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 2ac9f1bfce..72365d7d4c 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointendpointserviceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -47,25 +47,23 @@ Options * - --cloudProvider - string - true - - Cloud service provider that manages this private endpoint. + - cloud service provider that manages this private endpoint * - --endpointId - string - true - - Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. + - unique string that identifies the private endpoint you want to delete * - --endpointServiceId - string - true - - Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint. + - unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -81,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-privateEndpointServices-deletePrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 15552b40eb..3fdb4c9bd9 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointendpointservice. For more information and examples, see the referenced API documentation linked above. @@ -47,21 +47,19 @@ Options * - --cloudProvider - string - true - - Cloud service provider that manages this private endpoint service. + - cloud service provider that manages this private endpoint service * - --endpointServiceId - string - true - - Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. + - unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -107,8 +105,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-privateEndpointServices-deletePrivateEndpointService-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index fd9f8dc40c..c1d880798d 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointendpointserviceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -47,25 +47,23 @@ Options * - --cloudProvider - string - true - - Cloud service provider that manages this private endpoint. + - cloud service provider that manages this private endpoint * - --endpointId - string - true - - Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. + - unique string that identifies the private endpoint you want to return * - --endpointServiceId - string - true - - Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint. + - unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -81,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-privateEndpointServices-getPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 076e2c5565..c0caf6800a 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointendpointservice. For more information and examples, see the referenced API documentation linked above. @@ -47,21 +47,19 @@ Options * - --cloudProvider - string - true - - Cloud service provider that manages this private endpoint service. + - cloud service provider that manages this private endpoint service * - --endpointServiceId - string - true - - Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. + - unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-privateEndpointServices-getPrivateEndpointService-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalEndpointMode.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalEndpointMode.txt new file mode 100644 index 0000000000..67f89dfac8 --- /dev/null +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalEndpointMode.txt @@ -0,0 +1,91 @@ +.. _atlas-api-privateEndpointServices-getRegionalEndpointMode: + +========================================================= +atlas api privateEndpointServices getRegionalEndpointMode +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointregionalmode. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api privateEndpointServices getRegionalEndpointMode [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getRegionalEndpointMode + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt deleted file mode 100644 index 3ac6848bab..0000000000 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting: - -======================================================================= -atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting -======================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getregionalizedprivateendpointsetting. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting [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 getRegionalizedPrivateEndpointSetting - * - -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. - * - --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-privateEndpointServices-getRegionalizedPrivateEndpointSetting-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointService.txt new file mode 100644 index 0000000000..c0da969497 --- /dev/null +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointService.txt @@ -0,0 +1,95 @@ +.. _atlas-api-privateEndpointServices-listPrivateEndpointService: + +============================================================ +atlas api privateEndpointServices listPrivateEndpointService +============================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivateendpointendpointservice. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api privateEndpointServices listPrivateEndpointService [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 + * - --cloudProvider + - string + - true + - cloud service provider that manages this private endpoint service + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listPrivateEndpointService + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt deleted file mode 100644 index a30b6b234c..0000000000 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-privateEndpointServices-listPrivateEndpointServices: - -============================================================= -atlas api privateEndpointServices listPrivateEndpointServices -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivateendpointservices. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api privateEndpointServices listPrivateEndpointServices [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 - * - --cloudProvider - - string - - true - - Cloud service provider that manages this private endpoint service. - * - --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 listPrivateEndpointServices - * - -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. - * - --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-privateEndpointServices-listPrivateEndpointServices-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalEndpointMode.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalEndpointMode.txt new file mode 100644 index 0000000000..f9e43f6ee9 --- /dev/null +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalEndpointMode.txt @@ -0,0 +1,95 @@ +.. _atlas-api-privateEndpointServices-toggleRegionalEndpointMode: + +============================================================ +atlas api privateEndpointServices toggleRegionalEndpointMode +============================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupprivateendpointregionalmode. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api privateEndpointServices toggleRegionalEndpointMode [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for toggleRegionalEndpointMode + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt deleted file mode 100644 index d69ea9ac9a..0000000000 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting: - -========================================================================== -atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting -========================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleregionalizedprivateendpointsetting. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 toggleRegionalizedPrivateEndpointSetting - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 9b7fee3b8e..65097a1124 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -60,9 +60,9 @@ Related Commands * :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - Removes one private endpoint service from the specified project. * :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - Returns the connection state of the specified private endpoint. * :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalEndpointMode` - Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointService` - Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalEndpointMode` - Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. .. toctree:: @@ -74,7 +74,7 @@ Related Commands deletePrivateEndpointService getPrivateEndpoint getPrivateEndpointService - getRegionalizedPrivateEndpointSetting - listPrivateEndpointServices - toggleRegionalizedPrivateEndpointSetting + getRegionalEndpointMode + listPrivateEndpointService + toggleRegionalEndpointMode diff --git a/docs/command/atlas-api-programmaticApiKeys-addGroupApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addGroupApiKey.txt new file mode 100644 index 0000000000..9bf1e8b7e7 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-addGroupApiKey.txt @@ -0,0 +1,101 @@ +.. _atlas-api-programmaticApiKeys-addGroupApiKey: + +============================================ +atlas api programmaticApiKeys addGroupApiKey +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Assigns the specified organization API key to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys addGroupApiKey [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 + * - --apiUserId + - string + - true + - Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 addGroupApiKey + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt deleted file mode 100644 index 7b803f9653..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-programmaticApiKeys-addProjectApiKey: - -============================================== -atlas api programmaticApiKeys addProjectApiKey -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Assigns the specified organization API key to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys addProjectApiKey [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addProjectApiKey - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt deleted file mode 100644 index a3f3f9d914..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-programmaticApiKeys-createApiKey: - -========================================== -atlas api programmaticApiKeys createApiKey -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one API key for the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys createApiKey [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createApiKey - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt deleted file mode 100644 index f5100436fd..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. _atlas-api-programmaticApiKeys-createApiKeyAccessList: - -==================================================== -atlas api programmaticApiKeys createApiKeyAccessList -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates the access list entries for the specified organization API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikeyaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys createApiKeyAccessList [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createApiKeyAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-programmaticApiKeys-createGroupApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createGroupApiKey.txt new file mode 100644 index 0000000000..64bf7bdc06 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-createGroupApiKey.txt @@ -0,0 +1,97 @@ +.. _atlas-api-programmaticApiKeys-createGroupApiKey: + +=============================================== +atlas api programmaticApiKeys createGroupApiKey +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates and assigns the specified organization API key to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys createGroupApiKey [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupApiKey + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-createOrgAccessEntry.txt b/docs/command/atlas-api-programmaticApiKeys-createOrgAccessEntry.txt new file mode 100644 index 0000000000..f24d3d44ca --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-createOrgAccessEntry.txt @@ -0,0 +1,111 @@ +.. _atlas-api-programmaticApiKeys-createOrgAccessEntry: + +================================================== +atlas api programmaticApiKeys createOrgAccessEntry +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates the access list entries for the specified organization API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgapikeyaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys createOrgAccessEntry [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 + * - --apiUserId + - string + - true + - unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgAccessEntry + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-createOrgApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createOrgApiKey.txt new file mode 100644 index 0000000000..01efaef09e --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-createOrgApiKey.txt @@ -0,0 +1,95 @@ +.. _atlas-api-programmaticApiKeys-createOrgApiKey: + +============================================= +atlas api programmaticApiKeys createOrgApiKey +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one API key for the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys createOrgApiKey [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgApiKey + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt deleted file mode 100644 index 633c5dc234..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-programmaticApiKeys-createProjectApiKey: - -================================================= -atlas api programmaticApiKeys createProjectApiKey -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates and assigns the specified organization API key to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys createProjectApiKey [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectApiKey - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteAccessEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteAccessEntry.txt new file mode 100644 index 0000000000..a3acf80a51 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-deleteAccessEntry.txt @@ -0,0 +1,99 @@ +.. _atlas-api-programmaticApiKeys-deleteAccessEntry: + +=============================================== +atlas api programmaticApiKeys deleteAccessEntry +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified access list entry from the specified organization API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgapikeyaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys deleteAccessEntry [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 + * - --apiUserId + - string + - true + - unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for deleteAccessEntry + * - --ipAddress + - string + - true + - one IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt deleted file mode 100644 index 85d46ab6d4..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-programmaticApiKeys-deleteApiKey: - -========================================== -atlas api programmaticApiKeys deleteApiKey -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one organization API key from the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys deleteApiKey [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key. - * - --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. - * - -h, --help - - - - false - - help for deleteApiKey - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-programmaticApiKeys-deleteApiKey-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt deleted file mode 100644 index b5bfbbee8b..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry: - -========================================================= -atlas api programmaticApiKeys deleteApiKeyAccessListEntry -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified access list entry from the specified organization API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikeyaccesslistentry. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys deleteApiKeyAccessListEntry [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. - * - --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. - * - -h, --help - - - - false - - help for deleteApiKeyAccessListEntry - * - --ipAddress - - string - - true - - One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-programmaticApiKeys-deleteApiKeyAccessListEntry-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteOrgApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteOrgApiKey.txt new file mode 100644 index 0000000000..8e411eca5c --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-deleteOrgApiKey.txt @@ -0,0 +1,100 @@ +.. _atlas-api-programmaticApiKeys-deleteOrgApiKey: + +============================================= +atlas api programmaticApiKeys deleteOrgApiKey +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one organization API key from the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys deleteOrgApiKey [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 + * - --apiUserId + - string + - true + - Unique 24-hexadecimal digit string that identifies this organization API key. + * - --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. + * - -h, --help + - + - false + - help for deleteOrgApiKey + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-programmaticApiKeys-deleteOrgApiKey-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt deleted file mode 100644 index 79e34f8bdd..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-programmaticApiKeys-getApiKey: - -======================================= -atlas api programmaticApiKeys getApiKey -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one organization API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys getApiKey [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. - * - --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. - * - -h, --help - - - - false - - help for getApiKey - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-programmaticApiKeys-getApiKey-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt deleted file mode 100644 index 956814a60b..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-programmaticApiKeys-getApiKeyAccessList: - -================================================= -atlas api programmaticApiKeys getApiKeyAccessList -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one access list entry for the specified organization API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikeyaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys getApiKeyAccessList [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. - * - --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. - * - -h, --help - - - - false - - help for getApiKeyAccessList - * - --ipAddress - - string - - true - - One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - * - --orgId - - string - - true - - 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. - * - -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. - * - --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-programmaticApiKeys-getApiKeyAccessList-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-getOrgAccessEntry.txt b/docs/command/atlas-api-programmaticApiKeys-getOrgAccessEntry.txt new file mode 100644 index 0000000000..a0d7fdf29b --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-getOrgAccessEntry.txt @@ -0,0 +1,99 @@ +.. _atlas-api-programmaticApiKeys-getOrgAccessEntry: + +=============================================== +atlas api programmaticApiKeys getOrgAccessEntry +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one access list entry for the specified organization API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikeyaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys getOrgAccessEntry [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 + * - --apiUserId + - string + - true + - unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for getOrgAccessEntry + * - --ipAddress + - string + - true + - one IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-getOrgApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getOrgApiKey.txt new file mode 100644 index 0000000000..eab922e866 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-getOrgApiKey.txt @@ -0,0 +1,100 @@ +.. _atlas-api-programmaticApiKeys-getOrgApiKey: + +========================================== +atlas api programmaticApiKeys getOrgApiKey +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one organization API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys getOrgApiKey [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 + * - --apiUserId + - string + - true + - Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. + * - --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. + * - -h, --help + - + - false + - help for getOrgApiKey + * - --orgId + - string + - true + - 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. + * - -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. + * - --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-programmaticApiKeys-getOrgApiKey-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt deleted file mode 100644 index 580983d22c..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries: - -========================================================== -atlas api programmaticApiKeys listApiKeyAccessListsEntries -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all access list entries that you configured for the specified organization API key. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeyaccesslistsentries. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys listApiKeyAccessListsEntries [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. - * - --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. - * - -h, --help - - - - false - - help for listApiKeyAccessListsEntries - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-programmaticApiKeys-listApiKeyAccessListsEntries-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt deleted file mode 100644 index 8f84b2a326..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-programmaticApiKeys-listApiKeys: - -========================================= -atlas api programmaticApiKeys listApiKeys -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all organization API keys for the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeys. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys listApiKeys [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. - * - -h, --help - - - - false - - help for listApiKeys - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-programmaticApiKeys-listApiKeys-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-listGroupApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listGroupApiKeys.txt new file mode 100644 index 0000000000..d8e3eef4e5 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-listGroupApiKeys.txt @@ -0,0 +1,110 @@ +.. _atlas-api-programmaticApiKeys-listGroupApiKeys: + +============================================== +atlas api programmaticApiKeys listGroupApiKeys +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all organization API keys that you assigned to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupapikeys. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys listGroupApiKeys [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 listGroupApiKeys + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-programmaticApiKeys-listGroupApiKeys-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-listOrgAccessEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listOrgAccessEntries.txt new file mode 100644 index 0000000000..c6fbe1af8e --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-listOrgAccessEntries.txt @@ -0,0 +1,107 @@ +.. _atlas-api-programmaticApiKeys-listOrgAccessEntries: + +================================================== +atlas api programmaticApiKeys listOrgAccessEntries +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all access list entries that you configured for the specified organization API key. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgapikeyaccesslistentries. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys listOrgAccessEntries [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 + * - --apiUserId + - string + - true + - unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listOrgAccessEntries + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys-listOrgApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listOrgApiKeys.txt new file mode 100644 index 0000000000..f047b043d5 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-listOrgApiKeys.txt @@ -0,0 +1,108 @@ +.. _atlas-api-programmaticApiKeys-listOrgApiKeys: + +============================================ +atlas api programmaticApiKeys listOrgApiKeys +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all organization API keys for the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgapikeys. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys listOrgApiKeys [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. + * - -h, --help + - + - false + - help for listOrgApiKeys + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --orgId + - string + - true + - 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. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-programmaticApiKeys-listOrgApiKeys-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt deleted file mode 100644 index 8b0d977a7e..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-programmaticApiKeys-listProjectApiKeys: - -================================================ -atlas api programmaticApiKeys listProjectApiKeys -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all organization API keys that you assigned to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectapikeys. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys listProjectApiKeys [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 listProjectApiKeys - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-programmaticApiKeys-listProjectApiKeys-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-removeGroupApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeGroupApiKey.txt new file mode 100644 index 0000000000..08152cbe0c --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-removeGroupApiKey.txt @@ -0,0 +1,102 @@ +.. _atlas-api-programmaticApiKeys-removeGroupApiKey: + +=============================================== +atlas api programmaticApiKeys removeGroupApiKey +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one organization API key from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys removeGroupApiKey [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 + * - --apiUserId + - string + - true + - Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. + * - --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 removeGroupApiKey + * - -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. + * - --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-programmaticApiKeys-removeGroupApiKey-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt deleted file mode 100644 index 4d84f78083..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-programmaticApiKeys-removeProjectApiKey: - -================================================= -atlas api programmaticApiKeys removeProjectApiKey -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one organization API key from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys removeProjectApiKey [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. - * - --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 removeProjectApiKey - * - -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. - * - --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-programmaticApiKeys-removeProjectApiKey-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt deleted file mode 100644 index d027878166..0000000000 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-programmaticApiKeys-updateApiKey: - -========================================== -atlas api programmaticApiKeys updateApiKey -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one organization API key in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api programmaticApiKeys updateApiKey [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 - * - --apiUserId - - string - - true - - Unique 24-hexadecimal digit string that identifies this organization API key you want to update. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateApiKey - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 7321faca95..87ae103a12 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikeyroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupapikeyroles. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --apiUserId - string - true - - Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. + - unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,11 +67,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -85,11 +83,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-programmaticApiKeys-updateOrgApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateOrgApiKey.txt new file mode 100644 index 0000000000..e07529b5c3 --- /dev/null +++ b/docs/command/atlas-api-programmaticApiKeys-updateOrgApiKey.txt @@ -0,0 +1,99 @@ +.. _atlas-api-programmaticApiKeys-updateOrgApiKey: + +============================================= +atlas api programmaticApiKeys updateOrgApiKey +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one organization API key in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgapikey. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api programmaticApiKeys updateOrgApiKey [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 + * - --apiUserId + - string + - true + - Unique 24-hexadecimal digit string that identifies this organization API key you want to update. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgApiKey + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 1b5794a72e..33403d0d98 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -54,37 +54,37 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-addGroupApiKey` - Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createGroupApiKey` - Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createOrgAccessEntry` - Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createOrgApiKey` - Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteAccessEntry` - Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-deleteOrgApiKey` - Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-getOrgAccessEntry` - Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getOrgApiKey` - Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-listGroupApiKeys` - Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-listOrgAccessEntries` - Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listOrgApiKeys` - Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-removeGroupApiKey` - Removes one organization API key from the specified project. * :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-updateOrgApiKey` - Updates one organization API key in the specified organization. .. toctree:: :titlesonly: - addProjectApiKey - createApiKey - createApiKeyAccessList - createProjectApiKey - deleteApiKey - deleteApiKeyAccessListEntry - getApiKey - getApiKeyAccessList - listApiKeyAccessListsEntries - listApiKeys - listProjectApiKeys - removeProjectApiKey - updateApiKey + addGroupApiKey + createGroupApiKey + createOrgAccessEntry + createOrgApiKey + deleteAccessEntry + deleteOrgApiKey + getOrgAccessEntry + getOrgApiKey + listGroupApiKeys + listOrgAccessEntries + listOrgApiKeys + removeGroupApiKey updateApiKeyRoles + updateOrgApiKey diff --git a/docs/command/atlas-api-projectIpAccessList-createAccessListEntry.txt b/docs/command/atlas-api-projectIpAccessList-createAccessListEntry.txt new file mode 100644 index 0000000000..71bf6f5b2c --- /dev/null +++ b/docs/command/atlas-api-projectIpAccessList-createAccessListEntry.txt @@ -0,0 +1,107 @@ +.. _atlas-api-projectIpAccessList-createAccessListEntry: + +=================================================== +atlas api projectIpAccessList createAccessListEntry +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one or more access list entries to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projectIpAccessList createAccessListEntry [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createAccessListEntry + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt deleted file mode 100644 index f19fb24a3b..0000000000 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-api-projectIpAccessList-createProjectIpAccessList: - -======================================================= -atlas api projectIpAccessList createProjectIpAccessList -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one or more access list entries to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectipaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projectIpAccessList createProjectIpAccessList [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectIpAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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 --------- - -Adds multiple access list entries to the specified project - -Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add-payload.json - :language: shell -After creating ``payload.json``, run the command below in the same directory. - -.. literalinclude:: /includes/examples/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add.sh - :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList-deleteAccessListEntry.txt b/docs/command/atlas-api-projectIpAccessList-deleteAccessListEntry.txt new file mode 100644 index 0000000000..731c08ae33 --- /dev/null +++ b/docs/command/atlas-api-projectIpAccessList-deleteAccessListEntry.txt @@ -0,0 +1,95 @@ +.. _atlas-api-projectIpAccessList-deleteAccessListEntry: + +=================================================== +atlas api projectIpAccessList deleteAccessListEntry +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one access list entry from the specified project's IP access list. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projectIpAccessList deleteAccessListEntry [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 + * - --entryValue + - string + - true + - access list entry that you want to remove from the project's IP access list + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteAccessListEntry + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt deleted file mode 100644 index 1640f13962..0000000000 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-projectIpAccessList-deleteProjectIpAccessList: - -======================================================= -atlas api projectIpAccessList deleteProjectIpAccessList -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one access list entry from the specified project's IP access list. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectipaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projectIpAccessList deleteProjectIpAccessList [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 - * - --entryValue - - / - - true - - Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: - - - how your application established the connection, - - how MongoDB Cloud or the driver using the address behaves, and - - which protocol (like TCP or UDP) the connection uses. - * - --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 deleteProjectIpAccessList - * - -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. - * - --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-projectIpAccessList-deleteProjectIpAccessList-2023-01-01-project_ip_access_list_delete.sh - :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList-getAccessListEntry.txt b/docs/command/atlas-api-projectIpAccessList-getAccessListEntry.txt new file mode 100644 index 0000000000..10ea2c66c6 --- /dev/null +++ b/docs/command/atlas-api-projectIpAccessList-getAccessListEntry.txt @@ -0,0 +1,95 @@ +.. _atlas-api-projectIpAccessList-getAccessListEntry: + +================================================ +atlas api projectIpAccessList getAccessListEntry +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one access list entry from the specified project's IP access list. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projectIpAccessList getAccessListEntry [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 + * - --entryValue + - string + - true + - access list entry that you want to return from the project's IP access list + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAccessListEntry + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-projectIpAccessList-getAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getAccessListStatus.txt new file mode 100644 index 0000000000..5d87cffd47 --- /dev/null +++ b/docs/command/atlas-api-projectIpAccessList-getAccessListStatus.txt @@ -0,0 +1,95 @@ +.. _atlas-api-projectIpAccessList-getAccessListStatus: + +================================================= +atlas api projectIpAccessList getAccessListStatus +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the status of one project IP access list entry. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupaccessliststatus. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projectIpAccessList getAccessListStatus [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 + * - --entryValue + - string + - true + - network address or cloud provider security construct that identifies which project access list entry to be verified + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getAccessListStatus + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt deleted file mode 100644 index c25c46eda8..0000000000 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-projectIpAccessList-getProjectIpAccessListStatus: - -========================================================== -atlas api projectIpAccessList getProjectIpAccessListStatus -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the status of one project IP access list entry. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectipaccessliststatus. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projectIpAccessList getProjectIpAccessListStatus [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 - * - --entryValue - - string - - true - - Network address or cloud provider security construct that identifies which project access list entry to be verified. - * - --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 getProjectIpAccessListStatus - * - -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. - * - --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-projectIpAccessList-getProjectIpAccessListStatus-2023-01-01-project_ip_access_list_get_status.sh - :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt deleted file mode 100644 index 0f6656154f..0000000000 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-projectIpAccessList-getProjectIpList: - -============================================== -atlas api projectIpAccessList getProjectIpList -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one access list entry from the specified project's IP access list. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectiplist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projectIpAccessList getProjectIpList [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 - * - --entryValue - - / - - true - - Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (`%2F`). - * - --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 getProjectIpList - * - -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. - * - --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-projectIpAccessList-getProjectIpList-2023-01-01-project_ip_access_list_get.sh - :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList-listAccessListEntries.txt b/docs/command/atlas-api-projectIpAccessList-listAccessListEntries.txt new file mode 100644 index 0000000000..953c0f0d94 --- /dev/null +++ b/docs/command/atlas-api-projectIpAccessList-listAccessListEntries.txt @@ -0,0 +1,103 @@ +.. _atlas-api-projectIpAccessList-listAccessListEntries: + +=================================================== +atlas api projectIpAccessList listAccessListEntries +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all access list entries from the specified project's IP access list. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupaccesslistentries. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projectIpAccessList listAccessListEntries [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listAccessListEntries + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt deleted file mode 100644 index 04cb9c2dab..0000000000 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-projectIpAccessList-listProjectIpAccessLists: - -====================================================== -atlas api projectIpAccessList listProjectIpAccessLists -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all access list entries from the specified project's IP access list. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectipaccesslists. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projectIpAccessList listProjectIpAccessLists [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 listProjectIpAccessLists - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-projectIpAccessList-listProjectIpAccessLists-2023-01-01-project_ip_access_list_list.sh - :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 282a9ad05f..fcbfeb5187 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -54,19 +54,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createAccessListEntry` - Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteAccessListEntry` - Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getAccessListEntry` - Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getAccessListStatus` - Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-listAccessListEntries` - Returns all access list entries from the specified project's IP access list. .. toctree:: :titlesonly: - createProjectIpAccessList - deleteProjectIpAccessList - getProjectIpAccessListStatus - getProjectIpList - listProjectIpAccessLists + createAccessListEntry + deleteAccessListEntry + getAccessListEntry + getAccessListStatus + listAccessListEntries diff --git a/docs/command/atlas-api-projects-addGroupUser.txt b/docs/command/atlas-api-projects-addGroupUser.txt new file mode 100644 index 0000000000..2fade8c3dd --- /dev/null +++ b/docs/command/atlas-api-projects-addGroupUser.txt @@ -0,0 +1,95 @@ +.. _atlas-api-projects-addGroupUser: + +=============================== +atlas api projects addGroupUser +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one MongoDB Cloud user to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupaccessuser. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects addGroupUser [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for addGroupUser + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt deleted file mode 100644 index a06b90336f..0000000000 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-projects-addUserToProject: - -=================================== -atlas api projects addUserToProject -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one MongoDB Cloud user to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addusertoproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects addUserToProject [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addUserToProject - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. - diff --git a/docs/command/atlas-api-projects-createGroup.txt b/docs/command/atlas-api-projects-createGroup.txt new file mode 100644 index 0000000000..8e39c31062 --- /dev/null +++ b/docs/command/atlas-api-projects-createGroup.txt @@ -0,0 +1,108 @@ +.. _atlas-api-projects-createGroup: + +============================== +atlas api projects createGroup +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroup. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects createGroup [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createGroup + * - -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. + * - --projectOwnerId + - string + - false + - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. + * - --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 +-------- + +Creates a new project named "MongoTube" with an environment tag set to "e2e" + +Create the file below and save it as ``payload.json`` + + .. literalinclude:: /includes/examples/atlas-api-projects-createGroup-2023-01-01-create_project-payload.json + :language: shell +After creating ``payload.json``, run the command below in the same directory. + +.. literalinclude:: /includes/examples/atlas-api-projects-createGroup-2023-01-01-create_project.sh + :language: shell diff --git a/docs/command/atlas-api-projects-createGroupInvite.txt b/docs/command/atlas-api-projects-createGroupInvite.txt new file mode 100644 index 0000000000..1a7bc4d505 --- /dev/null +++ b/docs/command/atlas-api-projects-createGroupInvite.txt @@ -0,0 +1,97 @@ +.. _atlas-api-projects-createGroupInvite: + +==================================== +atlas api projects createGroupInvite +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invites one MongoDB Cloud user to join the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupinvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects createGroupInvite [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupInvite + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt deleted file mode 100644 index 354dfe99ba..0000000000 --- a/docs/command/atlas-api-projects-createProject.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-projects-createProject: - -================================ -atlas api projects createProject -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects createProject [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createProject - * - -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. - * - --projectOwnerId - - string - - false - - Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. - * - --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 --------- - -Creates a new project named "MongoTube" with an environment tag set to "e2e" - -Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-projects-createProject-2023-01-01-create_project-payload.json - :language: shell -After creating ``payload.json``, run the command below in the same directory. - -.. literalinclude:: /includes/examples/atlas-api-projects-createProject-2023-01-01-create_project.sh - :language: shell diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt deleted file mode 100644 index eaaef5e31c..0000000000 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-projects-createProjectInvitation: - -========================================== -atlas api projects createProjectInvitation -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invites one MongoDB Cloud user to join the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects createProjectInvitation [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectInvitation - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-projects-deleteGroup.txt b/docs/command/atlas-api-projects-deleteGroup.txt new file mode 100644 index 0000000000..879e070ac3 --- /dev/null +++ b/docs/command/atlas-api-projects-deleteGroup.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-deleteGroup: + +============================== +atlas api projects deleteGroup +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroup. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects deleteGroup [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 deleteGroup + * - -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. + * - --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-projects-deleteGroup-2023-01-01-delete_project.sh + :language: shell diff --git a/docs/command/atlas-api-projects-deleteGroupInvite.txt b/docs/command/atlas-api-projects-deleteGroupInvite.txt new file mode 100644 index 0000000000..cfa36f4077 --- /dev/null +++ b/docs/command/atlas-api-projects-deleteGroupInvite.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-deleteGroupInvite: + +==================================== +atlas api projects deleteGroupInvite +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupinvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects deleteGroupInvite [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 deleteGroupInvite + * - --invitationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the invitation. + * - -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) + * - --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-projects-deleteGroupInvite-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-deleteGroupLimit.txt b/docs/command/atlas-api-projects-deleteGroupLimit.txt new file mode 100644 index 0000000000..ad1f2c098c --- /dev/null +++ b/docs/command/atlas-api-projects-deleteGroupLimit.txt @@ -0,0 +1,118 @@ +.. _atlas-api-projects-deleteGroupLimit: + +=================================== +atlas api projects deleteGroupLimit +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified project limit. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegrouplimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects deleteGroupLimit [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 deleteGroupLimit + * - --limitName + - string + - true + - Human-readable label that identifies this project limit. + + | Limit Name | Description | Default | API Override Limit | + | --- | --- | --- | --- | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | + | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | + | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | + | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | + | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | + | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | + | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | + | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | + | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | + | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| + | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| + + * - -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. + * - --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-projects-deleteGroupLimit-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt deleted file mode 100644 index f089a39341..0000000000 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-deleteProject: - -================================ -atlas api projects deleteProject -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects deleteProject [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 deleteProject - * - -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. - * - --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-projects-deleteProject-2023-01-01-delete_project.sh - :language: shell diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt deleted file mode 100644 index e005b6f627..0000000000 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-deleteProjectInvitation: - -========================================== -atlas api projects deleteProjectInvitation -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects deleteProjectInvitation [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 deleteProjectInvitation - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - -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) - * - --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-projects-deleteProjectInvitation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt deleted file mode 100644 index 0cb36fd223..0000000000 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ /dev/null @@ -1,119 +0,0 @@ -.. _atlas-api-projects-deleteProjectLimit: - -===================================== -atlas api projects deleteProjectLimit -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified project limit. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectlimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects deleteProjectLimit [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 deleteProjectLimit - * - --limitName - - string - - true - - Human-readable label that identifies this project limit. - - | Limit Name | Description | Default | API Override Limit | - | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | - | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | - | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | - | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | - | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | - | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | - | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | - | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | - | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | - | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| - | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - - * - -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. - * - --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-projects-deleteProjectLimit-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-getGroup.txt b/docs/command/atlas-api-projects-getGroup.txt new file mode 100644 index 0000000000..987861b8b5 --- /dev/null +++ b/docs/command/atlas-api-projects-getGroup.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-getGroup: + +=========================== +atlas api projects getGroup +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroup. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroup [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 getGroup + * - -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. + * - --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-projects-getGroup-2023-01-01-get_project.sh + :language: shell diff --git a/docs/command/atlas-api-projects-getGroupByName.txt b/docs/command/atlas-api-projects-getGroupByName.txt new file mode 100644 index 0000000000..24146948ad --- /dev/null +++ b/docs/command/atlas-api-projects-getGroupByName.txt @@ -0,0 +1,91 @@ +.. _atlas-api-projects-getGroupByName: + +================================= +atlas api projects getGroupByName +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the project identified by its name. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbyname. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroupByName [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. + * - --groupName + - string + - true + - Human-readable label that identifies this project. + * - -h, --help + - + - false + - help for getGroupByName + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-projects-getGroupInvite.txt b/docs/command/atlas-api-projects-getGroupInvite.txt new file mode 100644 index 0000000000..cfb485ce08 --- /dev/null +++ b/docs/command/atlas-api-projects-getGroupInvite.txt @@ -0,0 +1,102 @@ +.. _atlas-api-projects-getGroupInvite: + +================================= +atlas api projects getGroupInvite +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of one pending invitation to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupinvite. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroupInvite [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 getGroupInvite + * - --invitationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the invitation. + * - -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. + * - --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-projects-getGroupInvite-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-getGroupIpAddresses.txt b/docs/command/atlas-api-projects-getGroupIpAddresses.txt new file mode 100644 index 0000000000..9ff18f304b --- /dev/null +++ b/docs/command/atlas-api-projects-getGroupIpAddresses.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-getGroupIpAddresses: + +====================================== +atlas api projects getGroupIpAddresses +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all IP addresses for this project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupipaddresses. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroupIpAddresses [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 getGroupIpAddresses + * - -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. + * - --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-projects-getGroupIpAddresses-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-getGroupLimit.txt b/docs/command/atlas-api-projects-getGroupLimit.txt new file mode 100644 index 0000000000..64e64db75b --- /dev/null +++ b/docs/command/atlas-api-projects-getGroupLimit.txt @@ -0,0 +1,118 @@ +.. _atlas-api-projects-getGroupLimit: + +================================ +atlas api projects getGroupLimit +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the specified limit for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroupLimit [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 getGroupLimit + * - --limitName + - string + - true + - Human-readable label that identifies this project limit. + + | Limit Name | Description | Default | API Override Limit | + | --- | --- | --- | --- | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | + | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | + | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | + | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | + | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | + | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | + | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | + | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | + | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | + | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| + | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| + + * - -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. + * - --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-projects-getGroupLimit-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-getGroupSettings.txt b/docs/command/atlas-api-projects-getGroupSettings.txt new file mode 100644 index 0000000000..3d2d15b18b --- /dev/null +++ b/docs/command/atlas-api-projects-getGroupSettings.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-getGroupSettings: + +=================================== +atlas api projects getGroupSettings +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about the specified project's settings. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupsettings. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getGroupSettings [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 getGroupSettings + * - -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. + * - --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-projects-getGroupSettings-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-getMongoDbVersions.txt b/docs/command/atlas-api-projects-getMongoDbVersions.txt new file mode 100644 index 0000000000..e30ac0c9c7 --- /dev/null +++ b/docs/command/atlas-api-projects-getMongoDbVersions.txt @@ -0,0 +1,109 @@ +.. _atlas-api-projects-getMongoDbVersions: + +===================================== +atlas api projects getMongoDbVersions +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupmongodbversions. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects getMongoDbVersions [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 + * - --cloudProvider + - string + - false + - filter results to only one cloud provider + * - --defaultStatus + - string + - false + - filter results to only the default values per tier + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getMongoDbVersions + * - --instanceSize + - string + - false + - filter results to only one instance size + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --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. + diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt deleted file mode 100644 index fc08652440..0000000000 --- a/docs/command/atlas-api-projects-getProject.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-getProject: - -============================= -atlas api projects getProject -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProject [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 getProject - * - -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. - * - --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-projects-getProject-2023-01-01-get_project.sh - :language: shell diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt deleted file mode 100644 index d0588bfc4c..0000000000 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-api-projects-getProjectByName: - -=================================== -atlas api projects getProjectByName -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the project identified by its name. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectbyname. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProjectByName [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. - * - --groupName - - string - - true - - Human-readable label that identifies this project. - * - -h, --help - - - - false - - help for getProjectByName - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt deleted file mode 100644 index 553e8f5da3..0000000000 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-projects-getProjectInvitation: - -======================================= -atlas api projects getProjectInvitation -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of one pending invitation to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProjectInvitation [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 getProjectInvitation - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - -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. - * - --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-projects-getProjectInvitation-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt deleted file mode 100644 index ed3ffbd91c..0000000000 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ /dev/null @@ -1,119 +0,0 @@ -.. _atlas-api-projects-getProjectLimit: - -================================== -atlas api projects getProjectLimit -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the specified limit for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectlimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProjectLimit [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 getProjectLimit - * - --limitName - - string - - true - - Human-readable label that identifies this project limit. - - | Limit Name | Description | Default | API Override Limit | - | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | - | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | - | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | - | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | - | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | - | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | - | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | - | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | - | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | - | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| - | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - - * - -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. - * - --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-projects-getProjectLimit-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt deleted file mode 100644 index 0a91bf333e..0000000000 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ /dev/null @@ -1,116 +0,0 @@ -.. _atlas-api-projects-getProjectLtsVersions: - -======================================== -atlas api projects getProjectLtsVersions -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectltsversions. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProjectLtsVersions [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 - * - --cloudProvider - - string - - false - - Filter results to only one cloud provider. - * - --defaultStatus - - string - - false - - Filter results to only the default values per tier. This value must be DEFAULT. - * - --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 getProjectLtsVersions - * - --instanceSize - - string - - false - - Filter results to only one instance size. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-projects-getProjectLtsVersions-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt deleted file mode 100644 index 3c92c54c1f..0000000000 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-getProjectSettings: - -===================================== -atlas api projects getProjectSettings -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about the specified project's settings. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects getProjectSettings [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 getProjectSettings - * - -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. - * - --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-projects-getProjectSettings-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-listGroupInvites.txt b/docs/command/atlas-api-projects-listGroupInvites.txt new file mode 100644 index 0000000000..25366cf7ae --- /dev/null +++ b/docs/command/atlas-api-projects-listGroupInvites.txt @@ -0,0 +1,102 @@ +.. _atlas-api-projects-listGroupInvites: + +=================================== +atlas api projects listGroupInvites +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all pending invitations to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupinvites. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects listGroupInvites [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 listGroupInvites + * - -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. + * - --username + - string + - false + - Email address of the user account invited to this project. + * - --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-projects-listGroupInvites-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-listGroupLimits.txt b/docs/command/atlas-api-projects-listGroupLimits.txt new file mode 100644 index 0000000000..a3d906bea5 --- /dev/null +++ b/docs/command/atlas-api-projects-listGroupLimits.txt @@ -0,0 +1,98 @@ +.. _atlas-api-projects-listGroupLimits: + +================================== +atlas api projects listGroupLimits +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all the limits for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouplimits. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects listGroupLimits [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 listGroupLimits + * - -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. + * - --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-projects-listGroupLimits-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-projects-listGroups.txt b/docs/command/atlas-api-projects-listGroups.txt new file mode 100644 index 0000000000..fd96952449 --- /dev/null +++ b/docs/command/atlas-api-projects-listGroups.txt @@ -0,0 +1,104 @@ +.. _atlas-api-projects-listGroups: + +============================= +atlas api projects listGroups +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details about all projects. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroups. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects listGroups [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. + * - -h, --help + - + - false + - help for listGroups + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-projects-listGroups-2023-01-01-list_projects.sh + :language: shell diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt deleted file mode 100644 index b92bc22a3c..0000000000 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-projects-listProjectInvitations: - -========================================= -atlas api projects listProjectInvitations -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all pending invitations to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectinvitations. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects listProjectInvitations [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 listProjectInvitations - * - -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. - * - --username - - string - - false - - Email address of the user account invited to this project. - * - --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-projects-listProjectInvitations-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt deleted file mode 100644 index 3486503d86..0000000000 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-listProjectLimits: - -==================================== -atlas api projects listProjectLimits -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all the limits for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectlimits. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects listProjectLimits [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 listProjectLimits - * - -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. - * - --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-projects-listProjectLimits-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt deleted file mode 100644 index 8a121ef71e..0000000000 --- a/docs/command/atlas-api-projects-listProjects.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-projects-listProjects: - -=============================== -atlas api projects listProjects -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details about all projects. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojects. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects listProjects [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. - * - -h, --help - - - - false - - help for listProjects - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-projects-listProjects-2023-01-01-list_projects.sh - :language: shell diff --git a/docs/command/atlas-api-projects-migrateGroup.txt b/docs/command/atlas-api-projects-migrateGroup.txt new file mode 100644 index 0000000000..01d6cc8c71 --- /dev/null +++ b/docs/command/atlas-api-projects-migrateGroup.txt @@ -0,0 +1,93 @@ +.. _atlas-api-projects-migrateGroup: + +=============================== +atlas api projects migrateGroup +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Migrates a project from its current organization to another organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-migrategroup. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects migrateGroup [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 migrateGroup + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt deleted file mode 100644 index 11c5a67c8e..0000000000 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-api-projects-migrateProjectToAnotherOrg: - -============================================= -atlas api projects migrateProjectToAnotherOrg -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Migrates a project from its current organization to another organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-migrateprojecttoanotherorg. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects migrateProjectToAnotherOrg [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 migrateProjectToAnotherOrg - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt deleted file mode 100644 index 21c58e2a62..0000000000 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-projects-returnAllIpAddresses: - -======================================= -atlas api projects returnAllIpAddresses -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all IP addresses for this project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnallipaddresses. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects returnAllIpAddresses [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 returnAllIpAddresses - * - -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. - * - --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-projects-returnAllIpAddresses-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-projects-setGroupLimit.txt b/docs/command/atlas-api-projects-setGroupLimit.txt new file mode 100644 index 0000000000..93a1697758 --- /dev/null +++ b/docs/command/atlas-api-projects-setGroupLimit.txt @@ -0,0 +1,120 @@ +.. _atlas-api-projects-setGroupLimit: + +================================ +atlas api projects setGroupLimit +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Sets the specified project limit. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgrouplimit. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects setGroupLimit [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 setGroupLimit + * - --limitName + - string + - true + - Human-readable label that identifies this project limit. + + | Limit Name | Description | Default | API Override Limit | + | --- | --- | --- | --- | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | + | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | + | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | + | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | + | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | + | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | + | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | + | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | + | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | + | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| + | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| + + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt deleted file mode 100644 index f9356407d7..0000000000 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ /dev/null @@ -1,121 +0,0 @@ -.. _atlas-api-projects-setProjectLimit: - -================================== -atlas api projects setProjectLimit -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Sets the specified project limit. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setprojectlimit. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects setProjectLimit [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 setProjectLimit - * - --limitName - - string - - true - - Human-readable label that identifies this project limit. - - | Limit Name | Description | Default | API Override Limit | - | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | - | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | - | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | - | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | - | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | - | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | - | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | - | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | - | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | - | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| - | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-projects-updateGroup.txt b/docs/command/atlas-api-projects-updateGroup.txt new file mode 100644 index 0000000000..9c31c93fda --- /dev/null +++ b/docs/command/atlas-api-projects-updateGroup.txt @@ -0,0 +1,110 @@ +.. _atlas-api-projects-updateGroup: + +============================== +atlas api projects updateGroup +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the human-readable label that identifies the specified project, or the tags associated with the project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroup. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects updateGroup [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroup + * - -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. + * - --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 +-------- + +Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" + +Create the file below and save it as ``payload.json`` + + .. literalinclude:: /includes/examples/atlas-api-projects-updateGroup-2023-01-01-update_project-payload.json + :language: shell +After creating ``payload.json``, run the command below in the same directory. + +.. literalinclude:: /includes/examples/atlas-api-projects-updateGroup-2023-01-01-update_project.sh + :language: shell diff --git a/docs/command/atlas-api-projects-updateGroupInvites.txt b/docs/command/atlas-api-projects-updateGroupInvites.txt new file mode 100644 index 0000000000..c71a6094e5 --- /dev/null +++ b/docs/command/atlas-api-projects-updateGroupInvites.txt @@ -0,0 +1,97 @@ +.. _atlas-api-projects-updateGroupInvites: + +===================================== +atlas api projects updateGroupInvites +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupinvites. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects updateGroupInvites [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupInvites + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-projects-updateGroupSettings.txt b/docs/command/atlas-api-projects-updateGroupSettings.txt new file mode 100644 index 0000000000..ac0515a3b0 --- /dev/null +++ b/docs/command/atlas-api-projects-updateGroupSettings.txt @@ -0,0 +1,97 @@ +.. _atlas-api-projects-updateGroupSettings: + +====================================== +atlas api projects updateGroupSettings +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the settings of the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupsettings. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects updateGroupSettings [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupSettings + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-projects-updateGroupUserRoles.txt b/docs/command/atlas-api-projects-updateGroupUserRoles.txt new file mode 100644 index 0000000000..4d73b4d1bc --- /dev/null +++ b/docs/command/atlas-api-projects-updateGroupUserRoles.txt @@ -0,0 +1,101 @@ +.. _atlas-api-projects-updateGroupUserRoles: + +======================================= +atlas api projects updateGroupUserRoles +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the roles of the specified user in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupuserroles. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects updateGroupUserRoles [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupUserRoles + * - -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. + * - --userId + - string + - true + - Unique 24-hexadecimal digit string that identifies the user to modify. + * - --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. + diff --git a/docs/command/atlas-api-projects-updateInviteById.txt b/docs/command/atlas-api-projects-updateInviteById.txt new file mode 100644 index 0000000000..0b50e1b4d6 --- /dev/null +++ b/docs/command/atlas-api-projects-updateInviteById.txt @@ -0,0 +1,95 @@ +.. _atlas-api-projects-updateInviteById: + +=================================== +atlas api projects updateInviteById +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the details of one pending invitation, identified by its unique ID, to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupinvitebyid. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api projects updateInviteById [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateInviteById + * - --invitationId + - string + - true + - unique 24-hexadecimal digit string that identifies the invitation + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt deleted file mode 100644 index 2efd3e7a1d..0000000000 --- a/docs/command/atlas-api-projects-updateProject.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-projects-updateProject: - -================================ -atlas api projects updateProject -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the human-readable label that identifies the specified project, or the tags associated with the project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects updateProject [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProject - * - -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. - * - --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 --------- - -Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" - -Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-projects-updateProject-2023-01-01-update_project-payload.json - :language: shell -After creating ``payload.json``, run the command below in the same directory. - -.. literalinclude:: /includes/examples/atlas-api-projects-updateProject-2023-01-01-update_project.sh - :language: shell diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt deleted file mode 100644 index fd567eea51..0000000000 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-projects-updateProjectInvitation: - -========================================== -atlas api projects updateProjectInvitation -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitation. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects updateProjectInvitation [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProjectInvitation - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt deleted file mode 100644 index 3533e3db99..0000000000 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-projects-updateProjectInvitationById: - -============================================== -atlas api projects updateProjectInvitationById -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the details of one pending invitation, identified by its unique ID, to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitationbyid. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects updateProjectInvitationById [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProjectInvitationById - * - --invitationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the invitation. - * - -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) - * - --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. - diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt deleted file mode 100644 index 552623a20a..0000000000 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-projects-updateProjectRoles: - -===================================== -atlas api projects updateProjectRoles -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the roles of the specified user in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectroles. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects updateProjectRoles [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProjectRoles - * - -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. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies the user to modify. - * - --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. - diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt deleted file mode 100644 index 91aace163f..0000000000 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-projects-updateProjectSettings: - -======================================== -atlas api projects updateProjectSettings -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the settings of the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectsettings. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api projects updateProjectSettings [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProjectSettings - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 94c4c3ea3f..481d9eb3ab 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -54,55 +54,55 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - Updates the details of one pending invitation, identified by its unique ID, to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - Updates the settings of the specified project. +* :ref:`atlas-api-projects-addGroupUser` - Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createGroup` - Creates one project. +* :ref:`atlas-api-projects-createGroupInvite` - Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteGroup` - Removes the specified project. +* :ref:`atlas-api-projects-deleteGroupInvite` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteGroupLimit` - Removes the specified project limit. +* :ref:`atlas-api-projects-getGroup` - Returns details about the specified project. +* :ref:`atlas-api-projects-getGroupByName` - Returns details about the project identified by its name. +* :ref:`atlas-api-projects-getGroupInvite` - Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getGroupIpAddresses` - Returns all IP addresses for this project. +* :ref:`atlas-api-projects-getGroupLimit` - Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getGroupSettings` - Returns details about the specified project's settings. +* :ref:`atlas-api-projects-getMongoDbVersions` - Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-listGroupInvites` - Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listGroupLimits` - Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listGroups` - Returns details about all projects. +* :ref:`atlas-api-projects-migrateGroup` - Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-setGroupLimit` - Sets the specified project limit. +* :ref:`atlas-api-projects-updateGroup` - Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateGroupInvites` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +* :ref:`atlas-api-projects-updateGroupSettings` - Updates the settings of the specified project. +* :ref:`atlas-api-projects-updateGroupUserRoles` - Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateInviteById` - Updates the details of one pending invitation, identified by its unique ID, to the specified project. .. toctree:: :titlesonly: - addUserToProject - createProject - createProjectInvitation - deleteProject - deleteProjectInvitation - deleteProjectLimit - getProject - getProjectByName - getProjectInvitation - getProjectLimit - getProjectLtsVersions - getProjectSettings - listProjectInvitations - listProjectLimits - listProjects - migrateProjectToAnotherOrg - returnAllIpAddresses - setProjectLimit - updateProject - updateProjectInvitation - updateProjectInvitationById - updateProjectRoles - updateProjectSettings + addGroupUser + createGroup + createGroupInvite + deleteGroup + deleteGroupInvite + deleteGroupLimit + getGroup + getGroupByName + getGroupInvite + getGroupIpAddresses + getGroupLimit + getGroupSettings + getMongoDbVersions + listGroupInvites + listGroupLimits + listGroups + migrateGroup + setGroupLimit + updateGroup + updateGroupInvites + updateGroupSettings + updateGroupUserRoles + updateInviteById diff --git a/docs/command/atlas-api-pushBasedLogExport-createLogExport.txt b/docs/command/atlas-api-pushBasedLogExport-createLogExport.txt new file mode 100644 index 0000000000..81b461e933 --- /dev/null +++ b/docs/command/atlas-api-pushBasedLogExport-createLogExport.txt @@ -0,0 +1,93 @@ +.. _atlas-api-pushBasedLogExport-createLogExport: + +============================================ +atlas api pushBasedLogExport createLogExport +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configures the project level settings for the push-based log export feature. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-creategrouppushbasedlogexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api pushBasedLogExport createLogExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createLogExport + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt deleted file mode 100644 index 78e89674f5..0000000000 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-pushBasedLogExport-createPushBasedLogConfiguration: - -============================================================ -atlas api pushBasedLogExport createPushBasedLogConfiguration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configures the project level settings for the push-based log export feature. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpushbasedlogconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api pushBasedLogExport createPushBasedLogConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createPushBasedLogConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-pushBasedLogExport-deleteLogExport.txt b/docs/command/atlas-api-pushBasedLogExport-deleteLogExport.txt new file mode 100644 index 0000000000..f14e43bb84 --- /dev/null +++ b/docs/command/atlas-api-pushBasedLogExport-deleteLogExport.txt @@ -0,0 +1,89 @@ +.. _atlas-api-pushBasedLogExport-deleteLogExport: + +============================================ +atlas api pushBasedLogExport deleteLogExport +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disables the push-based log export feature by resetting the project level settings to its default configuration. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-deletegrouppushbasedlogexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api pushBasedLogExport deleteLogExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteLogExport + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt deleted file mode 100644 index 9844d810f6..0000000000 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration: - -============================================================ -atlas api pushBasedLogExport deletePushBasedLogConfiguration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disables the push-based log export feature by resetting the project level settings to its default configuration. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepushbasedlogconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api pushBasedLogExport deletePushBasedLogConfiguration [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 deletePushBasedLogConfiguration - * - -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. - * - --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-pushBasedLogExport-deletePushBasedLogConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-pushBasedLogExport-getLogExport.txt b/docs/command/atlas-api-pushBasedLogExport-getLogExport.txt new file mode 100644 index 0000000000..3ff5596689 --- /dev/null +++ b/docs/command/atlas-api-pushBasedLogExport-getLogExport.txt @@ -0,0 +1,89 @@ +.. _atlas-api-pushBasedLogExport-getLogExport: + +========================================= +atlas api pushBasedLogExport getLogExport +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Fetches the current project level settings for the push-based log export feature. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgrouppushbasedlogexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api pushBasedLogExport getLogExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getLogExport + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt deleted file mode 100644 index 3243450d60..0000000000 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-api-pushBasedLogExport-getPushBasedLogConfiguration: - -========================================================= -atlas api pushBasedLogExport getPushBasedLogConfiguration -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Fetches the current project level settings for the push-based log export feature. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpushbasedlogconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api pushBasedLogExport getPushBasedLogConfiguration [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 getPushBasedLogConfiguration - * - -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. - * - --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-pushBasedLogExport-getPushBasedLogConfiguration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-pushBasedLogExport-updateLogExport.txt b/docs/command/atlas-api-pushBasedLogExport-updateLogExport.txt new file mode 100644 index 0000000000..4e172fe7c0 --- /dev/null +++ b/docs/command/atlas-api-pushBasedLogExport-updateLogExport.txt @@ -0,0 +1,93 @@ +.. _atlas-api-pushBasedLogExport-updateLogExport: + +============================================ +atlas api pushBasedLogExport updateLogExport +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the project level settings for the push-based log export feature. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-updategrouppushbasedlogexport. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api pushBasedLogExport updateLogExport [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateLogExport + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt deleted file mode 100644 index a4dd0d2571..0000000000 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration: - -============================================================ -atlas api pushBasedLogExport updatePushBasedLogConfiguration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the project level settings for the push-based log export feature. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepushbasedlogconfiguration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api pushBasedLogExport updatePushBasedLogConfiguration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updatePushBasedLogConfiguration - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 5852f296a8..3fd770d916 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -54,17 +54,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createLogExport` - Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deleteLogExport` - Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getLogExport` - Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updateLogExport` - Updates the project level settings for the push-based log export feature. .. toctree:: :titlesonly: - createPushBasedLogConfiguration - deletePushBasedLogConfiguration - getPushBasedLogConfiguration - updatePushBasedLogConfiguration + createLogExport + deleteLogExport + getLogExport + updateLogExport diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt deleted file mode 100644 index eede754838..0000000000 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails: - -==================================================================== -atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails -==================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the metadata and statistics summary for a given query shape hash. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -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 deleted file mode 100644 index 4b8e66972b..0000000000 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt +++ /dev/null @@ -1,140 +0,0 @@ -.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries: - -====================================================================== -atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries -====================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of query shape statistics summaries for a given cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -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-getQueryShapeDetails.txt b/docs/command/atlas-api-queryShapeInsights-getQueryShapeDetails.txt new file mode 100644 index 0000000000..308b64c1c8 --- /dev/null +++ b/docs/command/atlas-api-queryShapeInsights-getQueryShapeDetails.txt @@ -0,0 +1,109 @@ +.. _atlas-api-queryShapeInsights-getQueryShapeDetails: + +================================================= +atlas api queryShapeInsights getQueryShapeDetails +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the metadata and statistics summary for a given query shape hash. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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 getQueryShapeDetails [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getQueryShapeDetails + * - -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 + - stringArray + - false + - processIds from which to retrieve query shape statistics + * - --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 + * - --until + - int + - false + - date and time up until which to retrieve query shape statistics + * - --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. + diff --git a/docs/command/atlas-api-queryShapeInsights-listQueryShapeSummaries.txt b/docs/command/atlas-api-queryShapeInsights-listQueryShapeSummaries.txt new file mode 100644 index 0000000000..6ff3b96d4b --- /dev/null +++ b/docs/command/atlas-api-queryShapeInsights-listQueryShapeSummaries.txt @@ -0,0 +1,127 @@ +.. _atlas-api-queryShapeInsights-listQueryShapeSummaries: + +==================================================== +atlas api queryShapeInsights listQueryShapeSummaries +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of query shape statistics summaries for a given cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupclusterqueryshapeinsightsummaries. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api queryShapeInsights listQueryShapeSummaries [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 + - stringArray + - false + - retrieve query shape statistics matching specified MongoDB commands + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listQueryShapeSummaries + * - --nSummaries + - int + - false + - maximum number of query statistic summaries to return + * - --namespaces + - stringArray + - false + - namespaces from which to retrieve query shape statistics + * - -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 + - stringArray + - false + - processIds from which to retrieve query shape statistics + * - --queryShapeHashes + - stringArray + - false + - a list of SHA256 hashes of desired query shapes, output by MongoDB commands like $queryStats and $explain or slow query logs + * - --series + - stringArray + - false + - query shape statistics data series to retrieve + * - --since + - int + - false + - date and time from which to retrieve query shape statistics + * - --until + - int + - false + - date and time up until which to retrieve query shape statistics + * - --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. + diff --git a/docs/command/atlas-api-queryShapeInsights.txt b/docs/command/atlas-api-queryShapeInsights.txt index f979c8f7d2..188ca43db2 100644 --- a/docs/command/atlas-api-queryShapeInsights.txt +++ b/docs/command/atlas-api-queryShapeInsights.txt @@ -54,13 +54,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails` - Returns the metadata and statistics summary for a given query shape hash. -* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - Returns a list of query shape statistics summaries for a given cluster. +* :ref:`atlas-api-queryShapeInsights-getQueryShapeDetails` - Returns the metadata and statistics summary for a given query shape hash. +* :ref:`atlas-api-queryShapeInsights-listQueryShapeSummaries` - Returns a list of query shape statistics summaries for a given cluster. .. toctree:: :titlesonly: - getGroupClusterQueryShapeInsightDetails - getGroupClusterQueryShapeInsightSummaries + getQueryShapeDetails + listQueryShapeSummaries diff --git a/docs/command/atlas-api-resourcePolicies-getNonCompliantResources.txt b/docs/command/atlas-api-resourcePolicies-getNonCompliantResources.txt new file mode 100644 index 0000000000..50240e5d99 --- /dev/null +++ b/docs/command/atlas-api-resourcePolicies-getNonCompliantResources.txt @@ -0,0 +1,89 @@ +.. _atlas-api-resourcePolicies-getNonCompliantResources: + +=================================================== +atlas api resourcePolicies getNonCompliantResources +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all non-compliant resources for an org. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getorgnoncompliantresources. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api resourcePolicies getNonCompliantResources [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for getNonCompliantResources + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt deleted file mode 100644 index 1e220f8792..0000000000 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-api-resourcePolicies-getResourcesNonCompliant: - -=================================================== -atlas api resourcePolicies getResourcesNonCompliant -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all non-compliant resources for an org. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getresourcesnoncompliant. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api resourcePolicies getResourcesNonCompliant [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. - * - -h, --help - - - - false - - help for getResourcesNonCompliant - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-resourcePolicies-getResourcesNonCompliant-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt deleted file mode 100644 index 23b2e1f12a..0000000000 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-api-resourcePolicies-validateAtlasResourcePolicy: - -====================================================== -atlas api resourcePolicies validateAtlasResourcePolicy -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Validate one Atlas Resource Policy for an org. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validateatlasresourcepolicy. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api resourcePolicies validateAtlasResourcePolicy [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for validateAtlasResourcePolicy - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-resourcePolicies-validateResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-validateResourcePolicies.txt new file mode 100644 index 0000000000..0835fffca2 --- /dev/null +++ b/docs/command/atlas-api-resourcePolicies-validateResourcePolicies.txt @@ -0,0 +1,93 @@ +.. _atlas-api-resourcePolicies-validateResourcePolicies: + +=================================================== +atlas api resourcePolicies validateResourcePolicies +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Validate one Atlas Resource Policy for an org. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-validateorgresourcepolicies. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api resourcePolicies validateResourcePolicies [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for validateResourcePolicies + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 57642ed6ce..95e8c80c8e 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -56,11 +56,11 @@ Related Commands * :ref:`atlas-api-resourcePolicies-createOrgResourcePolicy` - Create one Atlas Resource Policy for an org. * :ref:`atlas-api-resourcePolicies-deleteOrgResourcePolicy` - Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getNonCompliantResources` - Return all non-compliant resources for an org. * :ref:`atlas-api-resourcePolicies-getOrgResourcePolicy` - Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - Return all non-compliant resources for an org. * :ref:`atlas-api-resourcePolicies-listOrgResourcePolicies` - Return all Atlas Resource Policies for the org. * :ref:`atlas-api-resourcePolicies-updateOrgResourcePolicy` - Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateResourcePolicies` - Validate one Atlas Resource Policy for an org. .. toctree:: @@ -68,9 +68,9 @@ Related Commands createOrgResourcePolicy deleteOrgResourcePolicy + getNonCompliantResources getOrgResourcePolicy - getResourcesNonCompliant listOrgResourcePolicies updateOrgResourcePolicy - validateAtlasResourcePolicy + validateResourcePolicies diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 34385577d6..964f97ba58 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrollingindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterindexrollingindex. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --clusterName - string - true - - Human-readable label that identifies the cluster on which MongoDB Cloud creates an index. + - human-readable label that identifies the cluster on which MongoDB Cloud creates an index * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -99,47 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. tabs:: - - .. tab:: Example - :tabid: 2023-01-01_2dspere_index - - 2dspere Index - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index.sh - :language: shell - .. tab:: Example 1 - :tabid: 2023-01-01_partial_index - - Partial Index - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index.sh - :language: shell - .. tab:: Example 2 - :tabid: 2023-01-01_sparse_index - - Sparse Index - - Create the file below and save it as ``payload.json`` - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index-payload.json - :language: shell - After creating ``payload.json``, run the command below in the same directory. - - .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index.sh - :language: shell diff --git a/docs/command/atlas-api-root-listControlPlaneAddresses.txt b/docs/command/atlas-api-root-listControlPlaneAddresses.txt new file mode 100644 index 0000000000..cd640b4690 --- /dev/null +++ b/docs/command/atlas-api-root-listControlPlaneAddresses.txt @@ -0,0 +1,81 @@ +.. _atlas-api-root-listControlPlaneAddresses: + +======================================== +atlas api root listControlPlaneAddresses +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all control plane IP addresses. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listcontrolplaneipaddresses. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api root listControlPlaneAddresses [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listControlPlaneAddresses + * - -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) + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". + +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. + diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt deleted file mode 100644 index 14ba546e28..0000000000 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ /dev/null @@ -1,81 +0,0 @@ -.. _atlas-api-root-returnAllControlPlaneIpAddresses: - -=============================================== -atlas api root returnAllControlPlaneIpAddresses -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all control plane IP addresses. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnallcontrolplaneipaddresses. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api root returnAllControlPlaneIpAddresses [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. - * - -h, --help - - - - false - - help for returnAllControlPlaneIpAddresses - * - -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) - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". - -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. - diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index cbe1cda473..63c97b53a3 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -55,12 +55,12 @@ Related Commands ---------------- * :ref:`atlas-api-root-getSystemStatus` - This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - Returns all control plane IP addresses. +* :ref:`atlas-api-root-listControlPlaneAddresses` - Returns all control plane IP addresses. .. toctree:: :titlesonly: getSystemStatus - returnAllControlPlaneIpAddresses + listControlPlaneAddresses diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index bdefed526a..688e647701 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -22,7 +22,7 @@ This endpoint will no longer be supported starting January 2026. Continuous back Creates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserverlessinstance. For more information and examples, see the referenced API documentation linked above. @@ -48,9 +48,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -58,9 +58,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index fb0b0b75df..c70685ee39 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -22,7 +22,7 @@ The serverless instance must have termination protection disabled in order to be This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserverlessinstance. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -64,7 +62,7 @@ Options * - --name - string - true - - Human-readable label that identifies the serverless instance. + - human-readable label that identifies the serverless instance * - -o, --output - string - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -106,8 +104,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-serverlessInstances-deleteServerlessInstance-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 7a909c7355..9b16c92821 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Pr This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessinstance. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -64,7 +62,7 @@ Options * - --name - string - true - - Human-readable label that identifies the serverless instance. + - human-readable label that identifies the serverless instance * - -o, --output - string - false @@ -76,7 +74,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -98,8 +96,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-serverlessInstances-getServerlessInstance-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 06ecf43f28..0e29dcc9b4 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Pr This endpoint also lists Flex clusters that were created using the createServerlessInstance endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessinstances. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessinstances. For more information and examples, see the referenced API documentation linked above. @@ -48,15 +48,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -64,11 +62,11 @@ Options * - --includeCount - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + - flag that indicates whether the response returns the total number of items (totalCount) in the response * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -80,11 +78,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -106,8 +104,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-serverlessInstances-listServerlessInstances-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index b24c54f7d8..953c49269e 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Pr This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupserverlessinstance. For more information and examples, see the referenced API documentation linked above. @@ -48,9 +48,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -58,9 +58,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -68,7 +66,7 @@ Options * - --name - string - true - - Human-readable label that identifies the serverless instance. + - human-readable label that identifies the serverless instance * - -o, --output - string - false @@ -80,7 +78,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index d79be2bebd..205979efe4 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -25,7 +25,7 @@ A new endpoint won't be immediately available after creation. Read the steps in This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointserverlessinstanceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -51,9 +51,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -61,9 +61,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -71,7 +69,7 @@ Options * - --instanceName - string - true - - Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. + - human-readable label that identifies the serverless instance for which the tenant endpoint will be created * - -o, --output - string - false diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index 55697287b7..9331623cce 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Pr This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointserverlessinstanceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -50,17 +50,15 @@ Options * - --endpointId - string - true - - Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. + - unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -68,7 +66,7 @@ Options * - --instanceName - string - true - - Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed. + - human-readable label that identifies the serverless instance from which the tenant endpoint will be removed * - -o, --output - string - false @@ -98,8 +96,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index a8ca642b19..2b959b9c1d 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -22,7 +22,7 @@ Identify this endpoint using its unique ID. You must have at least the Project R This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointserverlessinstanceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -50,17 +50,15 @@ Options * - --endpointId - string - true - - Unique 24-hexadecimal digit string that identifies the tenant endpoint. + - unique 24-hexadecimal digit string that identifies the tenant endpoint * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -68,7 +66,7 @@ Options * - --instanceName - string - true - - Human-readable label that identifies the serverless instance associated with the tenant endpoint. + - human-readable label that identifies the serverless instance associated with the tenant endpoint * - -o, --output - string - false @@ -98,8 +96,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoint.txt new file mode 100644 index 0000000000..e421e7ff2b --- /dev/null +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoint.txt @@ -0,0 +1,94 @@ +.. _atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoint: + +================================================================== +atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoint +================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all private endpoints for one serverless instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You must have at least the Project Read Only role for the project to successfully call this resource. + + +This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivateendpointserverlessinstanceendpoint. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoint [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listServerlessPrivateEndpoint + * - --instanceName + - string + - true + - human-readable label that identifies the serverless instance associated with the tenant endpoint + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt deleted file mode 100644 index abb96d5f51..0000000000 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints: - -=================================================================== -atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints -=================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all private endpoints for one serverless instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You must have at least the Project Read Only role for the project to successfully call this resource. - - -This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessprivateendpoints. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints [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 listServerlessPrivateEndpoints - * - --instanceName - - string - - true - - Human-readable label that identifies the serverless instance associated with the tenant endpoint. - * - -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) - * - --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-serverlessPrivateEndpoints-listServerlessPrivateEndpoints-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 8ca0a9b335..c0831e9daf 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -22,7 +22,7 @@ To use this resource, the requesting Service Account or API Key must have the Pr This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupprivateendpointserverlessinstanceendpoint. For more information and examples, see the referenced API documentation linked above. @@ -50,11 +50,11 @@ Options * - --endpointId - string - true - - Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. + - unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -62,9 +62,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -72,7 +70,7 @@ Options * - --instanceName - string - true - - Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated. + - human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated * - -o, --output - string - false diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 89bb697146..9c73aacd03 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -57,7 +57,7 @@ Related Commands * :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - Creates one private endpoint for one serverless instance. * :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - Remove one private endpoint from one serverless instance. * :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoint` - Returns all private endpoints for one serverless instance. * :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - Updates one private endpoint for one serverless instance. @@ -67,6 +67,6 @@ Related Commands createServerlessPrivateEndpoint deleteServerlessPrivateEndpoint getServerlessPrivateEndpoint - listServerlessPrivateEndpoints + listServerlessPrivateEndpoint updateServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt deleted file mode 100644 index 58fde47ab6..0000000000 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-serviceAccounts-addProjectServiceAccount: - -================================================== -atlas api serviceAccounts addProjectServiceAccount -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Assigns the specified Service Account to the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts addProjectServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addProjectServiceAccount - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createAccessList.txt b/docs/command/atlas-api-serviceAccounts-createAccessList.txt new file mode 100644 index 0000000000..b6fea8d6eb --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createAccessList.txt @@ -0,0 +1,111 @@ +.. _atlas-api-serviceAccounts-createAccessList: + +========================================== +atlas api serviceAccounts createAccessList +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add Access List Entries for the specified Service Account for the project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Resources require all API requests to originate from IP addresses on the API access list. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserviceaccountaccesslist. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createAccessList [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createAccessList + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createGroupSecret.txt b/docs/command/atlas-api-serviceAccounts-createGroupSecret.txt new file mode 100644 index 0000000000..304e294ad9 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createGroupSecret.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-createGroupSecret: + +=========================================== +atlas api serviceAccounts createGroupSecret +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a secret for the specified Service Account in the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-creategroupserviceaccountsecret. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createGroupSecret [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createGroupSecret + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createGroupServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createGroupServiceAccount.txt new file mode 100644 index 0000000000..db9fe4d53c --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createGroupServiceAccount.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-createGroupServiceAccount: + +=================================================== +atlas api serviceAccounts createGroupServiceAccount +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one Service Account for the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createGroupServiceAccount [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupServiceAccount + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createOrgAccessList.txt b/docs/command/atlas-api-serviceAccounts-createOrgAccessList.txt new file mode 100644 index 0000000000..dceb91f2bb --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createOrgAccessList.txt @@ -0,0 +1,111 @@ +.. _atlas-api-serviceAccounts-createOrgAccessList: + +============================================= +atlas api serviceAccounts createOrgAccessList +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add Access List Entries for the specified Service Account for the organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Resources require all API requests to originate from IP addresses on the API access list. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgserviceaccountaccesslist. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createOrgAccessList [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgAccessList + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createOrgSecret.txt b/docs/command/atlas-api-serviceAccounts-createOrgSecret.txt new file mode 100644 index 0000000000..8255224108 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createOrgSecret.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-createOrgSecret: + +========================================= +atlas api serviceAccounts createOrgSecret +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a secret for the specified Service Account. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-createorgserviceaccountsecret. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createOrgSecret [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgSecret + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createOrgServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createOrgServiceAccount.txt new file mode 100644 index 0000000000..c03a2d8035 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-createOrgServiceAccount.txt @@ -0,0 +1,93 @@ +.. _atlas-api-serviceAccounts-createOrgServiceAccount: + +================================================= +atlas api serviceAccounts createOrgServiceAccount +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one Service Account for the specified Organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-createorgserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts createOrgServiceAccount [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgServiceAccount + * - --orgId + - string + - true + - 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. + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt deleted file mode 100644 index dd9496e8ba..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-serviceAccounts-createProjectServiceAccount: - -===================================================== -atlas api serviceAccounts createProjectServiceAccount -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one Service Account for the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createProjectServiceAccount [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectServiceAccount - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt deleted file mode 100644 index 26dd35f084..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-serviceAccounts-createProjectServiceAccountAccessList: - -=============================================================== -atlas api serviceAccounts createProjectServiceAccountAccessList -=============================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Add Access List Entries for the specified Service Account for the project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Resources require all API requests to originate from IP addresses on the API access list. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createProjectServiceAccountAccessList [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectServiceAccountAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt deleted file mode 100644 index e52df35153..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-serviceAccounts-createProjectServiceAccountSecret: - -=========================================================== -atlas api serviceAccounts createProjectServiceAccountSecret -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a secret for the specified Service Account in the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountsecret. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createProjectServiceAccountSecret [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createProjectServiceAccountSecret - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt deleted file mode 100644 index 3b26488f5a..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-api-serviceAccounts-createServiceAccount: - -============================================== -atlas api serviceAccounts createServiceAccount -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one Service Account for the specified Organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createServiceAccount [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createServiceAccount - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt deleted file mode 100644 index aa3169f963..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. _atlas-api-serviceAccounts-createServiceAccountAccessList: - -======================================================== -atlas api serviceAccounts createServiceAccountAccessList -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Add Access List Entries for the specified Service Account for the organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Resources require all API requests to originate from IP addresses on the API access list. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createServiceAccountAccessList [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createServiceAccountAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt deleted file mode 100644 index 00a58fc67c..0000000000 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-serviceAccounts-createServiceAccountSecret: - -==================================================== -atlas api serviceAccounts createServiceAccountSecret -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a secret for the specified Service Account. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountsecret. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts createServiceAccountSecret [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createServiceAccountSecret - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-deleteGroupAccessEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteGroupAccessEntry.txt new file mode 100644 index 0000000000..b0f3d60852 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteGroupAccessEntry.txt @@ -0,0 +1,99 @@ +.. _atlas-api-serviceAccounts-deleteGroupAccessEntry: + +================================================ +atlas api serviceAccounts deleteGroupAccessEntry +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified access list entry from the specified Service Account for the project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't remove the requesting IP address from the access list. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserviceaccountaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteGroupAccessEntry [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteGroupAccessEntry + * - --ipAddress + - string + - true + - one IP address or multiple IP addresses represented as one CIDR block + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-deleteGroupSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteGroupSecret.txt new file mode 100644 index 0000000000..3500a250d6 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteGroupSecret.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-deleteGroupSecret: + +=========================================== +atlas api serviceAccounts deleteGroupSecret +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes the specified Service Account secret. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-deletegroupserviceaccountsecret. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteGroupSecret [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteGroupSecret + * - -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 + * - --secretId + - string + - true + - unique 24-hexadecimal digit string that identifies the secret + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-deleteGroupServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteGroupServiceAccount.txt new file mode 100644 index 0000000000..9e0029bc3f --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteGroupServiceAccount.txt @@ -0,0 +1,102 @@ +.. _atlas-api-serviceAccounts-deleteGroupServiceAccount: + +=================================================== +atlas api serviceAccounts deleteGroupServiceAccount +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified Service Account from the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteGroupServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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 deleteGroupServiceAccount + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-deleteGroupServiceAccount-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteOrgAccessEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteOrgAccessEntry.txt new file mode 100644 index 0000000000..9488d04c6f --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteOrgAccessEntry.txt @@ -0,0 +1,99 @@ +.. _atlas-api-serviceAccounts-deleteOrgAccessEntry: + +============================================== +atlas api serviceAccounts deleteOrgAccessEntry +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the specified access list entry from the specified Service Account for the organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can't remove the requesting IP address from the access list. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgserviceaccountaccesslistentry. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteOrgAccessEntry [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for deleteOrgAccessEntry + * - --ipAddress + - string + - true + - one IP address or multiple IP addresses represented as one CIDR block + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-deleteOrgSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteOrgSecret.txt new file mode 100644 index 0000000000..195994a240 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteOrgSecret.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-deleteOrgSecret: + +========================================= +atlas api serviceAccounts deleteOrgSecret +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes the specified Service Account secret. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-deleteorgserviceaccountsecret. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteOrgSecret [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for deleteOrgSecret + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 + * - --secretId + - string + - true + - unique 24-hexadecimal digit string that identifies the secret + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-deleteOrgServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteOrgServiceAccount.txt new file mode 100644 index 0000000000..c88d23fa93 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-deleteOrgServiceAccount.txt @@ -0,0 +1,98 @@ +.. _atlas-api-serviceAccounts-deleteOrgServiceAccount: + +================================================= +atlas api serviceAccounts deleteOrgServiceAccount +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deletes the specified Service Account. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-deleteorgserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts deleteOrgServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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. + * - -h, --help + - + - false + - help for deleteOrgServiceAccount + * - --orgId + - string + - true + - 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. + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-deleteOrgServiceAccount-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt deleted file mode 100644 index 3adb2cdfc0..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteProjectServiceAccount: - -===================================================== -atlas api serviceAccounts deleteProjectServiceAccount -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified Service Account from the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteProjectServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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 deleteProjectServiceAccount - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteProjectServiceAccount-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt deleted file mode 100644 index a2a096f049..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry: - -==================================================================== -atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry -==================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified access list entry from the specified Service Account for the project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't remove the requesting IP address from the access list. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountaccesslistentry. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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 deleteProjectServiceAccountAccessListEntry - * - --ipAddress - - string - - true - - One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteProjectServiceAccountAccessListEntry-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt deleted file mode 100644 index 24488475ac..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteProjectServiceAccountSecret: - -=========================================================== -atlas api serviceAccounts deleteProjectServiceAccountSecret -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes the specified Service Account secret. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountsecret. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteProjectServiceAccountSecret [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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 deleteProjectServiceAccountSecret - * - -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. - * - --secretId - - string - - true - - Unique 24-hexadecimal digit string that identifies the secret. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteProjectServiceAccountSecret-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt deleted file mode 100644 index dcff78c2df..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteServiceAccount: - -============================================== -atlas api serviceAccounts deleteServiceAccount -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes the specified Service Account. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for deleteServiceAccount - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteServiceAccount-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt deleted file mode 100644 index 1128ed1b26..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry: - -============================================================= -atlas api serviceAccounts deleteServiceAccountAccessListEntry -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the specified access list entry from the specified Service Account for the organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can't remove the requesting IP address from the access list. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountaccesslistentry. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteServiceAccountAccessListEntry [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for deleteServiceAccountAccessListEntry - * - --ipAddress - - string - - true - - One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteServiceAccountAccessListEntry-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt deleted file mode 100644 index b424186d49..0000000000 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-serviceAccounts-deleteServiceAccountSecret: - -==================================================== -atlas api serviceAccounts deleteServiceAccountSecret -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deletes the specified Service Account secret. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountsecret. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts deleteServiceAccountSecret [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for deleteServiceAccountSecret - * - --orgId - - string - - true - - 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. - * - -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. - * - --secretId - - string - - true - - Unique 24-hexadecimal digit string that identifies the secret. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-deleteServiceAccountSecret-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-getGroupServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getGroupServiceAccount.txt new file mode 100644 index 0000000000..d836187ca5 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-getGroupServiceAccount.txt @@ -0,0 +1,100 @@ +.. _atlas-api-serviceAccounts-getGroupServiceAccount: + +================================================ +atlas api serviceAccounts getGroupServiceAccount +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one Service Account in the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts getGroupServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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 getGroupServiceAccount + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-getGroupServiceAccount-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-getOrgServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getOrgServiceAccount.txt new file mode 100644 index 0000000000..f68eeecf2c --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-getOrgServiceAccount.txt @@ -0,0 +1,98 @@ +.. _atlas-api-serviceAccounts-getOrgServiceAccount: + +============================================== +atlas api serviceAccounts getOrgServiceAccount +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the specified Service Account. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getorgserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts getOrgServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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. + * - -h, --help + - + - false + - help for getOrgServiceAccount + * - --orgId + - string + - true + - 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. + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-getOrgServiceAccount-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt deleted file mode 100644 index 3432db49ff..0000000000 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-serviceAccounts-getProjectServiceAccount: - -================================================== -atlas api serviceAccounts getProjectServiceAccount -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one Service Account in the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts getProjectServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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 getProjectServiceAccount - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-getProjectServiceAccount-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt deleted file mode 100644 index 39dace91c5..0000000000 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-serviceAccounts-getServiceAccount: - -=========================================== -atlas api serviceAccounts getServiceAccount -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the specified Service Account. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts getServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for getServiceAccount - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-getServiceAccount-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccountGroups.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccountGroups.txt new file mode 100644 index 0000000000..0a5742e384 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccountGroups.txt @@ -0,0 +1,101 @@ +.. _atlas-api-serviceAccounts-getServiceAccountGroups: + +================================================= +atlas api serviceAccounts getServiceAccountGroups +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of all projects the specified Service Account is a part of. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getorgserviceaccountgroups. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts getServiceAccountGroups [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for getServiceAccountGroups + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-inviteGroupServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-inviteGroupServiceAccount.txt new file mode 100644 index 0000000000..9007d13637 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-inviteGroupServiceAccount.txt @@ -0,0 +1,99 @@ +.. _atlas-api-serviceAccounts-inviteGroupServiceAccount: + +=================================================== +atlas api serviceAccounts inviteGroupServiceAccount +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Assigns the specified Service Account to the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-invitegroupserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts inviteGroupServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 inviteGroupServiceAccount + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-listAccessList.txt b/docs/command/atlas-api-serviceAccounts-listAccessList.txt new file mode 100644 index 0000000000..47497a9383 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-listAccessList.txt @@ -0,0 +1,105 @@ +.. _atlas-api-serviceAccounts-listAccessList: + +======================================== +atlas api serviceAccounts listAccessList +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all access list entries that you configured for the specified Service Account for the project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupserviceaccountaccesslist. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts listAccessList [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listAccessList + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-listGroupServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listGroupServiceAccounts.txt new file mode 100644 index 0000000000..b9aeedf4b7 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-listGroupServiceAccounts.txt @@ -0,0 +1,104 @@ +.. _atlas-api-serviceAccounts-listGroupServiceAccounts: + +================================================== +atlas api serviceAccounts listGroupServiceAccounts +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Service Accounts for the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupserviceaccounts. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts listGroupServiceAccounts [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 listGroupServiceAccounts + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-listGroupServiceAccounts-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listOrgAccessList.txt b/docs/command/atlas-api-serviceAccounts-listOrgAccessList.txt new file mode 100644 index 0000000000..cd6fdf4f1d --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-listOrgAccessList.txt @@ -0,0 +1,105 @@ +.. _atlas-api-serviceAccounts-listOrgAccessList: + +=========================================== +atlas api serviceAccounts listOrgAccessList +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all access list entries that you configured for the specified Service Account for the organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listorgserviceaccountaccesslist. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts listOrgAccessList [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 + * - --clientId + - string + - true + - the Client ID of the Service Account + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for listOrgAccessList + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-listOrgServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listOrgServiceAccounts.txt new file mode 100644 index 0000000000..ac9222a030 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-listOrgServiceAccounts.txt @@ -0,0 +1,102 @@ +.. _atlas-api-serviceAccounts-listOrgServiceAccounts: + +================================================ +atlas api serviceAccounts listOrgServiceAccounts +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Service Accounts for the specified Organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listorgserviceaccounts. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts listOrgServiceAccounts [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. + * - -h, --help + - + - false + - help for listOrgServiceAccounts + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --orgId + - string + - true + - 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. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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-serviceAccounts-listOrgServiceAccounts-2024-08-05-default.sh + :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt deleted file mode 100644 index 429cafc6a8..0000000000 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-api-serviceAccounts-listProjectServiceAccountAccessList: - -============================================================= -atlas api serviceAccounts listProjectServiceAccountAccessList -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all access list entries that you configured for the specified Service Account for the project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccountaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts listProjectServiceAccountAccessList [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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 listProjectServiceAccountAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-listProjectServiceAccountAccessList-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt deleted file mode 100644 index 37f03ab638..0000000000 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-serviceAccounts-listProjectServiceAccounts: - -==================================================== -atlas api serviceAccounts listProjectServiceAccounts -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Service Accounts for the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccounts. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts listProjectServiceAccounts [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 listProjectServiceAccounts - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-listProjectServiceAccounts-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt deleted file mode 100644 index 062ade9b33..0000000000 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-serviceAccounts-listServiceAccountAccessList: - -====================================================== -atlas api serviceAccounts listServiceAccountAccessList -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all access list entries that you configured for the specified Service Account for the organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountaccesslist. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts listServiceAccountAccessList [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for listServiceAccountAccessList - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-listServiceAccountAccessList-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt deleted file mode 100644 index 144a779669..0000000000 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-serviceAccounts-listServiceAccountProjects: - -==================================================== -atlas api serviceAccounts listServiceAccountProjects -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of all projects the specified Service Account is a part of. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountprojects. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts listServiceAccountProjects [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - -h, --help - - - - false - - help for listServiceAccountProjects - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-listServiceAccountProjects-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt deleted file mode 100644 index 0bf1581411..0000000000 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-serviceAccounts-listServiceAccounts: - -============================================= -atlas api serviceAccounts listServiceAccounts -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Service Accounts for the specified Organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccounts. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts listServiceAccounts [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. - * - -h, --help - - - - false - - help for listServiceAccounts - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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-serviceAccounts-listServiceAccounts-2024-08-05-default.sh - :language: shell diff --git a/docs/command/atlas-api-serviceAccounts-updateGroupServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateGroupServiceAccount.txt new file mode 100644 index 0000000000..7e65478456 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-updateGroupServiceAccount.txt @@ -0,0 +1,99 @@ +.. _atlas-api-serviceAccounts-updateGroupServiceAccount: + +=================================================== +atlas api serviceAccounts updateGroupServiceAccount +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one Service Account in the specified Project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-updategroupserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts updateGroupServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupServiceAccount + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-updateOrgServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateOrgServiceAccount.txt new file mode 100644 index 0000000000..1b14981fd3 --- /dev/null +++ b/docs/command/atlas-api-serviceAccounts-updateOrgServiceAccount.txt @@ -0,0 +1,97 @@ +.. _atlas-api-serviceAccounts-updateOrgServiceAccount: + +================================================= +atlas api serviceAccounts updateOrgServiceAccount +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the specified Service Account in the specified Organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-updateorgserviceaccount. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api serviceAccounts updateOrgServiceAccount [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 + * - --clientId + - string + - true + - The Client ID of the Service Account. + * - --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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for updateOrgServiceAccount + * - --orgId + - string + - true + - 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. + * - -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. + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt deleted file mode 100644 index e8f26c8ecc..0000000000 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-serviceAccounts-updateProjectServiceAccount: - -===================================================== -atlas api serviceAccounts updateProjectServiceAccount -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one Service Account in the specified Project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts updateProjectServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateProjectServiceAccount - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt deleted file mode 100644 index a037461272..0000000000 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-serviceAccounts-updateServiceAccount: - -============================================== -atlas api serviceAccounts updateServiceAccount -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the specified Service Account in the specified Organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserviceaccount. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api serviceAccounts updateServiceAccount [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 - * - --clientId - - string - - true - - The Client ID of the Service Account. - * - --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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for updateServiceAccount - * - --orgId - - string - - true - - 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. - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 0aaf47ef7a..ebffde2d8c 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -54,53 +54,53 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-createAccessList` - Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createGroupSecret` - Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createGroupServiceAccount` - Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createOrgAccessList` - Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createOrgSecret` - Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-createOrgServiceAccount` - Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-deleteGroupAccessEntry` - Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteGroupSecret` - Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteGroupServiceAccount` - Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteOrgAccessEntry` - Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteOrgSecret` - Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteOrgServiceAccount` - Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-getGroupServiceAccount` - Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getOrgServiceAccount` - Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-getServiceAccountGroups` - Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-inviteGroupServiceAccount` - Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-listAccessList` - Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listGroupServiceAccounts` - Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listOrgAccessList` - Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listOrgServiceAccounts` - Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateGroupServiceAccount` - Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateOrgServiceAccount` - Updates the specified Service Account in the specified Organization. .. toctree:: :titlesonly: - addProjectServiceAccount - createProjectServiceAccount - createProjectServiceAccountAccessList - createProjectServiceAccountSecret - createServiceAccount - createServiceAccountAccessList - createServiceAccountSecret - deleteProjectServiceAccount - deleteProjectServiceAccountAccessListEntry - deleteProjectServiceAccountSecret - deleteServiceAccount - deleteServiceAccountAccessListEntry - deleteServiceAccountSecret - getProjectServiceAccount - getServiceAccount - listProjectServiceAccountAccessList - listProjectServiceAccounts - listServiceAccountAccessList - listServiceAccountProjects - listServiceAccounts - updateProjectServiceAccount - updateServiceAccount + createAccessList + createGroupSecret + createGroupServiceAccount + createOrgAccessList + createOrgSecret + createOrgServiceAccount + deleteGroupAccessEntry + deleteGroupSecret + deleteGroupServiceAccount + deleteOrgAccessEntry + deleteOrgSecret + deleteOrgServiceAccount + getGroupServiceAccount + getOrgServiceAccount + getServiceAccountGroups + inviteGroupServiceAccount + listAccessList + listGroupServiceAccounts + listOrgAccessList + listOrgServiceAccounts + updateGroupServiceAccount + updateOrgServiceAccount diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createBackupTenantRestore.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createBackupTenantRestore.txt new file mode 100644 index 0000000000..897df018ce --- /dev/null +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createBackupTenantRestore.txt @@ -0,0 +1,102 @@ +.. _atlas-api-sharedTierRestoreJobs-createBackupTenantRestore: + +========================================================= +atlas api sharedTierRestoreJobs createBackupTenantRestore +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Restores the specified M2 or M5 cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackuptenantrestore. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierRestoreJobs createBackupTenantRestore [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createBackupTenantRestore + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt deleted file mode 100644 index a185194296..0000000000 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob: - -=================================================================== -atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob -=================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restores the specified M2 or M5 cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createsharedclusterbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createSharedClusterBackupRestoreJob - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getBackupTenantRestore.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getBackupTenantRestore.txt new file mode 100644 index 0000000000..c5b8335a14 --- /dev/null +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getBackupTenantRestore.txt @@ -0,0 +1,102 @@ +.. _atlas-api-sharedTierRestoreJobs-getBackupTenantRestore: + +====================================================== +atlas api sharedTierRestoreJobs getBackupTenantRestore +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the specified restore job for the specified M2 or M5 cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuptenantrestore. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierRestoreJobs getBackupTenantRestore [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getBackupTenantRestore + * - -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 + * - --restoreId + - string + - true + - unique 24-hexadecimal digit string that identifies the restore job to return + * - --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. + diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt deleted file mode 100644 index 40bf79d2be..0000000000 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob: - -================================================================ -atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob -================================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the specified restore job for the specified M2 or M5 cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsharedclusterbackuprestorejob. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob [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 getSharedClusterBackupRestoreJob - * - -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. - * - --restoreId - - string - - true - - Unique 24-hexadecimal digit string that identifies the restore job to return. - * - --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-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listBackupTenantRestores.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listBackupTenantRestores.txt new file mode 100644 index 0000000000..aff9b64e8e --- /dev/null +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listBackupTenantRestores.txt @@ -0,0 +1,98 @@ +.. _atlas-api-sharedTierRestoreJobs-listBackupTenantRestores: + +======================================================== +atlas api sharedTierRestoreJobs listBackupTenantRestores +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all restore jobs for the specified M2 or M5 cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuptenantrestores. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierRestoreJobs listBackupTenantRestores [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listBackupTenantRestores + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt deleted file mode 100644 index 647ee36461..0000000000 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs: - -================================================================== -atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs -================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all restore jobs for the specified M2 or M5 cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsharedclusterbackuprestorejobs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs [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 listSharedClusterBackupRestoreJobs - * - -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. - * - --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-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 4f1481144c..5ceb83d061 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -54,15 +54,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createBackupTenantRestore` - Restores the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getBackupTenantRestore` - Returns the specified restore job for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-listBackupTenantRestores` - Returns all restore jobs for the specified M2 or M5 cluster. .. toctree:: :titlesonly: - createSharedClusterBackupRestoreJob - getSharedClusterBackupRestoreJob - listSharedClusterBackupRestoreJobs + createBackupTenantRestore + getBackupTenantRestore + listBackupTenantRestores diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadClusterBackupTenant.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadClusterBackupTenant.txt new file mode 100644 index 0000000000..33a332c156 --- /dev/null +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadClusterBackupTenant.txt @@ -0,0 +1,102 @@ +.. _atlas-api-sharedTierSnapshots-downloadClusterBackupTenant: + +========================================================= +atlas api sharedTierSnapshots downloadClusterBackupTenant +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Requests one snapshot for the specified shared cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusterbackuptenant. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierSnapshots downloadClusterBackupTenant [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for downloadClusterBackupTenant + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt deleted file mode 100644 index b7c98a5fa1..0000000000 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-sharedTierSnapshots-downloadSharedClusterBackup: - -========================================================= -atlas api sharedTierSnapshots downloadSharedClusterBackup -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Requests one snapshot for the specified shared cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadsharedclusterbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierSnapshots downloadSharedClusterBackup [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 downloadSharedClusterBackup - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-sharedTierSnapshots-getBackupTenantSnapshot.txt b/docs/command/atlas-api-sharedTierSnapshots-getBackupTenantSnapshot.txt new file mode 100644 index 0000000000..ca63940190 --- /dev/null +++ b/docs/command/atlas-api-sharedTierSnapshots-getBackupTenantSnapshot.txt @@ -0,0 +1,102 @@ +.. _atlas-api-sharedTierSnapshots-getBackupTenantSnapshot: + +===================================================== +atlas api sharedTierSnapshots getBackupTenantSnapshot +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details for one snapshot for the specified shared cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuptenantsnapshot. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierSnapshots getBackupTenantSnapshot [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getBackupTenantSnapshot + * - -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 + * - --snapshotId + - string + - true + - unique 24-hexadecimal digit string that identifies the desired snapshot + * - --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. + diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt deleted file mode 100644 index d10dbfaeb4..0000000000 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-api-sharedTierSnapshots-getSharedClusterBackup: - -==================================================== -atlas api sharedTierSnapshots getSharedClusterBackup -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details for one snapshot for the specified shared cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsharedclusterbackup. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierSnapshots getSharedClusterBackup [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 getSharedClusterBackup - * - -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. - * - --snapshotId - - string - - true - - Unique 24-hexadecimal digit string that identifies the desired snapshot. - * - --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-sharedTierSnapshots-getSharedClusterBackup-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-sharedTierSnapshots-listClusterBackupSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots-listClusterBackupSnapshots.txt new file mode 100644 index 0000000000..3ee18198c4 --- /dev/null +++ b/docs/command/atlas-api-sharedTierSnapshots-listClusterBackupSnapshots.txt @@ -0,0 +1,98 @@ +.. _atlas-api-sharedTierSnapshots-listClusterBackupSnapshots: + +======================================================== +atlas api sharedTierSnapshots listClusterBackupSnapshots +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns details for all snapshots for the specified shared cluster. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +This API also works for Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuptenantsnapshots. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api sharedTierSnapshots listClusterBackupSnapshots [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listClusterBackupSnapshots + * - -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 + * - --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. + diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt deleted file mode 100644 index 676159a80f..0000000000 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-sharedTierSnapshots-listSharedClusterBackups: - -====================================================== -atlas api sharedTierSnapshots listSharedClusterBackups -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns details for all snapshots for the specified shared cluster. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This API also works for Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsharedclusterbackups. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api sharedTierSnapshots listSharedClusterBackups [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 listSharedClusterBackups - * - -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. - * - --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-sharedTierSnapshots-listSharedClusterBackups-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index f9c891ac90..d8b37d15e9 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -54,15 +54,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadClusterBackupTenant` - Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getBackupTenantSnapshot` - Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listClusterBackupSnapshots` - Returns details for all snapshots for the specified shared cluster. .. toctree:: :titlesonly: - downloadSharedClusterBackup - getSharedClusterBackup - listSharedClusterBackups + downloadClusterBackupTenant + getBackupTenantSnapshot + listClusterBackupSnapshots diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 19ed19a8d2..2e0184bebb 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -17,7 +17,7 @@ Requests the acceptance of an incoming VPC Peering connection. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acceptvpcpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acceptgroupstreamvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. @@ -43,9 +43,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -53,9 +53,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -63,7 +61,7 @@ Options * - --id - string - true - - The VPC Peering Connection id. + - the VPC Peering Connection id * - -o, --output - string - false diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index d7b844fac1..43bd6f135d 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamprivatelinkconnection. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 9eea603ec5..5746bbeca5 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamconnection. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt deleted file mode 100644 index 11d4a3541e..0000000000 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-streams-createStreamInstance: - -====================================== -atlas api streams createStreamInstance -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one stream instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstance. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams createStreamInstance [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createStreamInstance - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. - diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt deleted file mode 100644 index fb493de421..0000000000 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-streams-createStreamInstanceWithSampleConnections: - -=========================================================== -atlas api streams createStreamInstanceWithSampleConnections -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one stream instance in the specified project with sample connections. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstancewithsampleconnections. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams createStreamInstanceWithSampleConnections [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createStreamInstanceWithSampleConnections - * - -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. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". - -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. - diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 0e23fd971e..527a9d54d0 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamprocessor. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false diff --git a/docs/command/atlas-api-streams-createStreamWorkspace.txt b/docs/command/atlas-api-streams-createStreamWorkspace.txt new file mode 100644 index 0000000000..c5977d45a4 --- /dev/null +++ b/docs/command/atlas-api-streams-createStreamWorkspace.txt @@ -0,0 +1,95 @@ +.. _atlas-api-streams-createStreamWorkspace: + +======================================= +atlas api streams createStreamWorkspace +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one stream instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamworkspace. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams createStreamWorkspace [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createStreamWorkspace + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 6447e7bd58..ce71a31723 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamprivatelinkconnection. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --connectionId - string - true - - Unique ID that identifies the Private Link connection. + - unique ID that identifies the Private Link connection * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-deletePrivateLinkConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 5bb124b7e7..21e43c400d 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamconnection. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --connectionName - string - true - - Human-readable label that identifies the stream connection. + - human-readable label that identifies the stream connection * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,11 +71,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-deleteStreamConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt deleted file mode 100644 index dd5fe54897..0000000000 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-streams-deleteStreamInstance: - -====================================== -atlas api streams deleteStreamInstance -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete one stream instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreaminstance. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams deleteStreamInstance [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 deleteStreamInstance - * - -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. - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance to delete. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-streams-deleteStreamInstance-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index ae37f7994a..96ebd70813 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamprocessor. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,15 +67,15 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processorName - string - true - - Human-readable label that identifies the stream processor. + - human-readable label that identifies the stream processor * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-deleteStreamProcessor-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-deleteStreamWorkspace.txt b/docs/command/atlas-api-streams-deleteStreamWorkspace.txt new file mode 100644 index 0000000000..99b6842f84 --- /dev/null +++ b/docs/command/atlas-api-streams-deleteStreamWorkspace.txt @@ -0,0 +1,95 @@ +.. _atlas-api-streams-deleteStreamWorkspace: + +======================================= +atlas api streams deleteStreamWorkspace +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete one stream instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamworkspace. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams deleteStreamWorkspace [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for deleteStreamWorkspace + * - -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 + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance to delete + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 8dde6ccf82..fd4a45796b 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -17,7 +17,7 @@ Deletes an incoming VPC Peering connection. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletevpcpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. @@ -43,15 +43,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -59,7 +57,7 @@ Options * - --id - string - true - - The VPC Peering Connection id. + - the VPC Peering Connection id * - -o, --output - string - false @@ -89,8 +87,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-deleteVpcPeeringConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-downloadAuditLogs.txt b/docs/command/atlas-api-streams-downloadAuditLogs.txt new file mode 100644 index 0000000000..8c2a233d66 --- /dev/null +++ b/docs/command/atlas-api-streams-downloadAuditLogs.txt @@ -0,0 +1,99 @@ +.. _atlas-api-streams-downloadAuditLogs: + +=================================== +atlas api streams downloadAuditLogs +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Downloads the audit logs for the specified Atlas Streams Processing instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupstreamauditlogs. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams downloadAuditLogs [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 + * - --endDate + - int + - false + - timestamp that specifies the end point for the range of log messages to download + * - --envelope + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for downloadAuditLogs + * - -o, --output + - string + - false + - preferred api format, can be ["gzip"] This value defaults to "gzip". + * - --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) + * - --startDate + - int + - false + - timestamp that specifies the starting point for the range of log messages to download + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt deleted file mode 100644 index f5efa38744..0000000000 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-api-streams-downloadStreamTenantAuditLogs: - -=============================================== -atlas api streams downloadStreamTenantAuditLogs -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Downloads the audit logs for the specified Atlas Streams Processing instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadstreamtenantauditlogs. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams downloadStreamTenantAuditLogs [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 - * - --endDate - - int - - false - - Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - * - --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 downloadStreamTenantAuditLogs - * - -o, --output - - string - - false - - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --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) - * - --startDate - - int - - false - - Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-streams-downloadStreamTenantAuditLogs-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index 75c5562355..f2062fb8b0 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -17,7 +17,7 @@ Returns the Account ID, and the VPC ID for the group and region specified. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getaccountdetails. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamaccountdetails. For more information and examples, see the referenced API documentation linked above. @@ -45,17 +45,15 @@ Options * - --cloudProvider - string - true - - One of "aws", "azure" or "gcp". + - one of "aws", "azure" or "gcp" * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -71,7 +69,7 @@ Options * - --regionName - string - true - - The cloud provider specific region name, i.e. "US_EAST_1" for cloud provider "aws". + - the cloud provider specific region name, i.e * - --version - string - false @@ -93,8 +91,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-getAccountDetails-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt deleted file mode 100644 index 06e9fb6ec8..0000000000 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-streams-getActiveVpcPeeringConnections: - -================================================ -atlas api streams getActiveVpcPeeringConnections -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of active incoming VPC Peering Connections. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getactivevpcpeeringconnections. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams getActiveVpcPeeringConnections [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 getActiveVpcPeeringConnections - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". - -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-streams-getActiveVpcPeeringConnections-2024-11-13-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 41f3aa6da8..e807a4b2a4 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprivatelinkconnection. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --connectionId - string - true - - Unique ID that identifies the Private Link connection. + - unique ID that identifies the Private Link connection * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -91,8 +89,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-getPrivateLinkConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index b6178537c7..bb0655a95d 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamconnection. For more information and examples, see the referenced API documentation linked above. @@ -47,17 +47,15 @@ Options * - --connectionName - string - true - - Human-readable label that identifies the stream connection to return. + - human-readable label that identifies the stream connection to return * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,7 +71,7 @@ Options * - --tenantName - string - true - - Human-readable label that identifies the stream instance to return. + - human-readable label that identifies the stream instance to return * - --version - string - false @@ -95,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-getStreamConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt deleted file mode 100644 index 4b3722f677..0000000000 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-streams-getStreamInstance: - -=================================== -atlas api streams getStreamInstance -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the details of one stream instance within the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreaminstance. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams getStreamInstance [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 getStreamInstance - * - --includeConnections - - - - false - - Flag to indicate whether connections information should be included in the stream instance. - * - -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) - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance to return. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-streams-getStreamInstance-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 0140ba1874..c08c672217 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprocessor. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,15 +67,15 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processorName - string - true - - Human-readable label that identifies the stream processor. + - human-readable label that identifies the stream processor * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-getStreamProcessor-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-getStreamProcessors.txt b/docs/command/atlas-api-streams-getStreamProcessors.txt new file mode 100644 index 0000000000..3b93e72436 --- /dev/null +++ b/docs/command/atlas-api-streams-getStreamProcessors.txt @@ -0,0 +1,107 @@ +.. _atlas-api-streams-getStreamProcessors: + +===================================== +atlas api streams getStreamProcessors +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Stream Processors within the specified stream instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprocessors. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams getStreamProcessors [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getStreamProcessors + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-streams-getStreamWorkspace.txt b/docs/command/atlas-api-streams-getStreamWorkspace.txt new file mode 100644 index 0000000000..696535419a --- /dev/null +++ b/docs/command/atlas-api-streams-getStreamWorkspace.txt @@ -0,0 +1,95 @@ +.. _atlas-api-streams-getStreamWorkspace: + +==================================== +atlas api streams getStreamWorkspace +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the details of one stream instance within the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamworkspace. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams getStreamWorkspace [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for getStreamWorkspace + * - --includeConnections + - + - false + - flag to indicate whether connections information should be included in the stream instance + * - -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) + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance to return + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt deleted file mode 100644 index 804c35958f..0000000000 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-streams-getVpcPeeringConnections: - -========================================== -atlas api streams getVpcPeeringConnections -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of incoming VPC Peering Connections. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getvpcpeeringconnections. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams getVpcPeeringConnections [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 getVpcPeeringConnections - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --requesterAccountId - - string - - true - - The Account ID of the VPC Peering connection/s. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-streams-getVpcPeeringConnections-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-listActivePeeringConnections.txt b/docs/command/atlas-api-streams-listActivePeeringConnections.txt new file mode 100644 index 0000000000..bcd87fb5e2 --- /dev/null +++ b/docs/command/atlas-api-streams-listActivePeeringConnections.txt @@ -0,0 +1,97 @@ +.. _atlas-api-streams-listActivePeeringConnections: + +============================================== +atlas api streams listActivePeeringConnections +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of active incoming VPC Peering Connections. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupstreamactivevpcpeeringconnections. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams listActivePeeringConnections [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listActivePeeringConnections + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13". + +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. + diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 834d39139c..98268bbac7 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivatelinkconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamprivatelinkconnections. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,7 +59,7 @@ Options * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -73,11 +71,11 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-listPrivateLinkConnections-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 06156f154f..8a1bb7e557 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamconnections. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -61,7 +59,7 @@ Options * - --itemsPerPage - int - false - - Number of items that the response returns per page. + - number of items that the response returns per page * - -o, --output - string - false @@ -73,15 +71,15 @@ Options * - --pageNum - int - false - - Number of the page that displays the current set of the total objects that the response returns. + - number of the page that displays the current set of the total objects that the response returns * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -103,8 +101,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-listStreamConnections-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt deleted file mode 100644 index 1b55a66c69..0000000000 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-api-streams-listStreamInstances: - -===================================== -atlas api streams listStreamInstances -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all stream instances for the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreaminstances. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams listStreamInstances [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 listStreamInstances - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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-streams-listStreamInstances-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt deleted file mode 100644 index 8954460dc6..0000000000 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-streams-listStreamProcessors: - -====================================== -atlas api streams listStreamProcessors -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Stream Processors within the specified stream instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamprocessors. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams listStreamProcessors [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 listStreamProcessors - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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-streams-listStreamProcessors-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-listStreamWorkspaces.txt b/docs/command/atlas-api-streams-listStreamWorkspaces.txt new file mode 100644 index 0000000000..a1d8a1466b --- /dev/null +++ b/docs/command/atlas-api-streams-listStreamWorkspaces.txt @@ -0,0 +1,97 @@ +.. _atlas-api-streams-listStreamWorkspaces: + +====================================== +atlas api streams listStreamWorkspaces +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all stream instances for the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupstreamworkspaces. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams listStreamWorkspaces [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listStreamWorkspaces + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-listVpcPeeringConnections.txt b/docs/command/atlas-api-streams-listVpcPeeringConnections.txt new file mode 100644 index 0000000000..a3ee26db7f --- /dev/null +++ b/docs/command/atlas-api-streams-listVpcPeeringConnections.txt @@ -0,0 +1,101 @@ +.. _atlas-api-streams-listVpcPeeringConnections: + +=========================================== +atlas api streams listVpcPeeringConnections +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of incoming VPC Peering Connections. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupstreamvpcpeeringconnections. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams listVpcPeeringConnections [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listVpcPeeringConnections + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --requesterAccountId + - string + - true + - the Account ID of the VPC Peering connection/s + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt deleted file mode 100644 index 63a1609798..0000000000 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-api-streams-modifyStreamProcessor: - -======================================= -atlas api streams modifyStreamProcessor -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify one existing Stream Processor within the specified stream instance. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-modifystreamprocessor. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams modifyStreamProcessor [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 modifyStreamProcessor - * - -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. - * - --processorName - - string - - true - - Human-readable label that identifies the stream processor. - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance. - * - --version - - string - - false - - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". - -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. - diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index d3e7a319b0..f4a193efee 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -17,7 +17,7 @@ Requests the rejection of an incoming VPC Peering connection. The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-rejectvpcpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-rejectgroupstreamvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. @@ -43,15 +43,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -59,7 +57,7 @@ Options * - --id - string - true - - The VPC Peering Connection id. + - the VPC Peering Connection id * - -o, --output - string - false @@ -89,8 +87,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-rejectVpcPeeringConnection-2023-02-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 1856de29d9..c9b327f3ba 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupstreamprocessor. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,15 +67,15 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processorName - string - true - - Human-readable label that identifies the stream processor. + - human-readable label that identifies the stream processor * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-startStreamProcessor-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index 04eacc3ddb..1fabe38264 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessorwith. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupstreamprocessorwith. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -55,9 +55,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -73,15 +71,15 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processorName - string - true - - Human-readable label that identifies the stream processor. + - human-readable label that identifies the stream processor * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 45891fb4be..5592d64123 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-stopstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-stopgroupstreamprocessor. For more information and examples, see the referenced API documentation linked above. @@ -45,15 +45,13 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -69,15 +67,15 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --processorName - string - true - - Human-readable label that identifies the stream processor. + - human-readable label that identifies the stream processor * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false @@ -99,8 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-streams-stopStreamProcessor-2024-05-30-default.sh - :language: shell diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index 276c774a29..013faa5e19 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamconnection. For more information and examples, see the referenced API documentation linked above. @@ -47,11 +47,11 @@ Options * - --connectionName - string - true - - Human-readable label that identifies the stream connection. + - human-readable label that identifies the stream connection * - --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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - --file - string - false @@ -59,9 +59,7 @@ Options * - --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. + - unique 24-hexadecimal digit string that identifies your project * - -h, --help - - false @@ -77,11 +75,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --tenantName - string - true - - Human-readable label that identifies the stream instance. + - human-readable label that identifies the stream instance * - --version - string - false diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt deleted file mode 100644 index d3d9085da0..0000000000 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-streams-updateStreamInstance: - -====================================== -atlas api streams updateStreamInstance -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update one stream instance in the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreaminstance. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api streams updateStreamInstance [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateStreamInstance - * - -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. - * - --tenantName - - string - - true - - Human-readable label that identifies the stream instance to update. - * - --version - - string - - false - - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. - diff --git a/docs/command/atlas-api-streams-updateStreamProcessor.txt b/docs/command/atlas-api-streams-updateStreamProcessor.txt new file mode 100644 index 0000000000..d792495585 --- /dev/null +++ b/docs/command/atlas-api-streams-updateStreamProcessor.txt @@ -0,0 +1,103 @@ +.. _atlas-api-streams-updateStreamProcessor: + +======================================= +atlas api streams updateStreamProcessor +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify one existing Stream Processor within the specified stream instance. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamprocessor. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams updateStreamProcessor [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateStreamProcessor + * - -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 + * - --processorName + - string + - true + - human-readable label that identifies the stream processor + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". + +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. + diff --git a/docs/command/atlas-api-streams-updateStreamWorkspace.txt b/docs/command/atlas-api-streams-updateStreamWorkspace.txt new file mode 100644 index 0000000000..dbeb165a64 --- /dev/null +++ b/docs/command/atlas-api-streams-updateStreamWorkspace.txt @@ -0,0 +1,99 @@ +.. _atlas-api-streams-updateStreamWorkspace: + +======================================= +atlas api streams updateStreamWorkspace +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update one stream instance in the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamworkspace. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams updateStreamWorkspace [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for updateStreamWorkspace + * - -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 + * - --tenantName + - string + - true + - human-readable label that identifies the stream instance to update + * - --version + - string + - false + - api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-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. + diff --git a/docs/command/atlas-api-streams-withStreamSampleConnections.txt b/docs/command/atlas-api-streams-withStreamSampleConnections.txt new file mode 100644 index 0000000000..9626c4dc9e --- /dev/null +++ b/docs/command/atlas-api-streams-withStreamSampleConnections.txt @@ -0,0 +1,95 @@ +.. _atlas-api-streams-withStreamSampleConnections: + +============================================= +atlas api streams withStreamSampleConnections +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one stream instance in the specified project with sample connections. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-withgroupstreamsampleconnections. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams withStreamSampleConnections [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for withStreamSampleConnections + * - -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 + * - --version + - string + - false + - api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". + +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. + diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 2b22aa920f..796a67ff43 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -57,33 +57,33 @@ Related Commands * :ref:`atlas-api-streams-acceptVpcPeeringConnection` - Requests the acceptance of an incoming VPC Peering connection. * :ref:`atlas-api-streams-createPrivateLinkConnection` - Creates one Private Link in the specified project. * :ref:`atlas-api-streams-createStreamConnection` - Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - Creates one stream instance in the specified project with sample connections. * :ref:`atlas-api-streams-createStreamProcessor` - Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-createStreamWorkspace` - Creates one stream instance in the specified project. * :ref:`atlas-api-streams-deletePrivateLinkConnection` - Deletes one Private Link in the specified project. * :ref:`atlas-api-streams-deleteStreamConnection` - Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - Delete one stream instance in the specified project. * :ref:`atlas-api-streams-deleteStreamProcessor` - Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamWorkspace` - Delete one stream instance in the specified project. * :ref:`atlas-api-streams-deleteVpcPeeringConnection` - Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-downloadAuditLogs` - Downloads the audit logs for the specified Atlas Streams Processing instance. * :ref:`atlas-api-streams-getAccountDetails` - Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - Returns a list of active incoming VPC Peering Connections. * :ref:`atlas-api-streams-getPrivateLinkConnection` - Returns the details of one Private Link connection within the project. * :ref:`atlas-api-streams-getStreamConnection` - Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - Returns the details of one stream instance within the specified project. * :ref:`atlas-api-streams-getStreamProcessor` - Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-getStreamProcessors` - Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-getStreamWorkspace` - Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-listActivePeeringConnections` - Returns a list of active incoming VPC Peering Connections. * :ref:`atlas-api-streams-listPrivateLinkConnections` - Returns all Private Link connections for the specified project. * :ref:`atlas-api-streams-listStreamConnections` - Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-listStreamWorkspaces` - Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listVpcPeeringConnections` - Returns a list of incoming VPC Peering Connections. * :ref:`atlas-api-streams-rejectVpcPeeringConnection` - Requests the rejection of an incoming VPC Peering connection. * :ref:`atlas-api-streams-startStreamProcessor` - Start a Stream Processor within the specified stream instance. * :ref:`atlas-api-streams-startStreamProcessorWith` - Start a Stream Processor within the specified stream instance. * :ref:`atlas-api-streams-stopStreamProcessor` - Stop a Stream Processor within the specified stream instance. * :ref:`atlas-api-streams-updateStreamConnection` - Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - Update one stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamProcessor` - Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamWorkspace` - Update one stream instance in the specified project. +* :ref:`atlas-api-streams-withStreamSampleConnections` - Creates one stream instance in the specified project with sample connections. .. toctree:: @@ -92,31 +92,31 @@ Related Commands acceptVpcPeeringConnection createPrivateLinkConnection createStreamConnection - createStreamInstance - createStreamInstanceWithSampleConnections createStreamProcessor + createStreamWorkspace deletePrivateLinkConnection deleteStreamConnection - deleteStreamInstance deleteStreamProcessor + deleteStreamWorkspace deleteVpcPeeringConnection - downloadStreamTenantAuditLogs + downloadAuditLogs getAccountDetails - getActiveVpcPeeringConnections getPrivateLinkConnection getStreamConnection - getStreamInstance getStreamProcessor - getVpcPeeringConnections + getStreamProcessors + getStreamWorkspace + listActivePeeringConnections listPrivateLinkConnections listStreamConnections - listStreamInstances - listStreamProcessors - modifyStreamProcessor + listStreamWorkspaces + listVpcPeeringConnections rejectVpcPeeringConnection startStreamProcessor startStreamProcessorWith stopStreamProcessor updateStreamConnection - updateStreamInstance + updateStreamProcessor + updateStreamWorkspace + withStreamSampleConnections diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt deleted file mode 100644 index 8a51faf5d6..0000000000 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-api-teams-addAllTeamsToProject: - -==================================== -atlas api teams addAllTeamsToProject -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one or more teams to the specified project. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addallteamstoproject. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams addAllTeamsToProject [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 addAllTeamsToProject - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-teams-addGroupTeams.txt b/docs/command/atlas-api-teams-addGroupTeams.txt new file mode 100644 index 0000000000..c3eb8789e2 --- /dev/null +++ b/docs/command/atlas-api-teams-addGroupTeams.txt @@ -0,0 +1,97 @@ +.. _atlas-api-teams-addGroupTeams: + +============================= +atlas api teams addGroupTeams +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one or more teams to the specified project. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupteams. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams addGroupTeams [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 addGroupTeams + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt deleted file mode 100644 index dbc08f7f6e..0000000000 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-teams-addTeamUser: - -=========================== -atlas api teams addTeamUser -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds one or more MongoDB Cloud users from the specified organization to the specified team. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This endpoint is deprecated. Use Add One MongoDB Cloud User to One Team to add an active or pending user to a team. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addteamuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams addTeamUser [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for addTeamUser - * - --orgId - - string - - true - - 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. - * - -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 character string that identifies the team to which you want to add MongoDB Cloud users. - * - --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. - diff --git a/docs/command/atlas-api-teams-addTeamUsers.txt b/docs/command/atlas-api-teams-addTeamUsers.txt new file mode 100644 index 0000000000..fe327992de --- /dev/null +++ b/docs/command/atlas-api-teams-addTeamUsers.txt @@ -0,0 +1,102 @@ +.. _atlas-api-teams-addTeamUsers: + +============================ +atlas api teams addTeamUsers +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds one or more MongoDB Cloud users from the specified organization to the specified team. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This endpoint is deprecated. Use Add One MongoDB Cloud User to One Team to add an active or pending user to a team. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorgteamusers. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams addTeamUsers [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for addTeamUsers + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 character string that identifies the team to which you want to add MongoDB Cloud users + * - --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. + diff --git a/docs/command/atlas-api-teams-createOrgTeam.txt b/docs/command/atlas-api-teams-createOrgTeam.txt new file mode 100644 index 0000000000..49e53c9049 --- /dev/null +++ b/docs/command/atlas-api-teams-createOrgTeam.txt @@ -0,0 +1,95 @@ +.. _atlas-api-teams-createOrgTeam: + +============================= +atlas api teams createOrgTeam +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one team in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams createOrgTeam [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for createOrgTeam + * - --orgId + - string + - true + - 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. + * - -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. + * - --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. + diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt deleted file mode 100644 index 4d3b24fe4d..0000000000 --- a/docs/command/atlas-api-teams-createTeam.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-api-teams-createTeam: - -========================== -atlas api teams createTeam -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one team in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams createTeam [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for createTeam - * - --orgId - - string - - true - - 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. - * - -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. - * - --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. - diff --git a/docs/command/atlas-api-teams-deleteOrgTeam.txt b/docs/command/atlas-api-teams-deleteOrgTeam.txt new file mode 100644 index 0000000000..f152589070 --- /dev/null +++ b/docs/command/atlas-api-teams-deleteOrgTeam.txt @@ -0,0 +1,100 @@ +.. _atlas-api-teams-deleteOrgTeam: + +============================= +atlas api teams deleteOrgTeam +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams deleteOrgTeam [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. + * - -h, --help + - + - false + - help for deleteOrgTeam + * - --orgId + - string + - true + - 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. + * - -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 that you want to delete. + * - --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-deleteOrgTeam-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt deleted file mode 100644 index a2a7da6170..0000000000 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-teams-deleteTeam: - -========================== -atlas api teams deleteTeam -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams deleteTeam [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. - * - -h, --help - - - - false - - help for deleteTeam - * - --orgId - - string - - true - - 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. - * - -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 that you want to delete. - * - --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-deleteTeam-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-getGroupTeam.txt b/docs/command/atlas-api-teams-getGroupTeam.txt new file mode 100644 index 0000000000..9254dbbf67 --- /dev/null +++ b/docs/command/atlas-api-teams-getGroupTeam.txt @@ -0,0 +1,102 @@ +.. _atlas-api-teams-getGroupTeam: + +============================ +atlas api teams getGroupTeam +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +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 is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-getgroupteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams getGroupTeam [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 getGroupTeam + * - -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-getGroupTeam-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-getOrgTeam.txt b/docs/command/atlas-api-teams-getOrgTeam.txt new file mode 100644 index 0000000000..4bf7eafe0a --- /dev/null +++ b/docs/command/atlas-api-teams-getOrgTeam.txt @@ -0,0 +1,100 @@ +.. _atlas-api-teams-getOrgTeam: + +========================== +atlas api teams getOrgTeam +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns one team that you identified using its unique 24-hexadecimal digit ID. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams getOrgTeam [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. + * - -h, --help + - + - false + - help for getOrgTeam + * - --orgId + - string + - true + - 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. + * - -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 whose information you want to return. + * - --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-getOrgTeam-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-getProjectTeam.txt b/docs/command/atlas-api-teams-getProjectTeam.txt deleted file mode 100644 index 9c7fd1b8a9..0000000000 --- a/docs/command/atlas-api-teams-getProjectTeam.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-teams-getProjectTeam: - -============================== -atlas api teams getProjectTeam -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -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 is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -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-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt deleted file mode 100644 index 1216358183..0000000000 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-api-teams-getTeamById: - -=========================== -atlas api teams getTeamById -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns one team that you identified using its unique 24-hexadecimal digit ID. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyid. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams getTeamById [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. - * - -h, --help - - - - false - - help for getTeamById - * - --orgId - - string - - true - - 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. - * - -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 whose information you want to return. - * - --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-getTeamById-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 94b095b0bc..131e81dfbf 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgteambyname. For more information and examples, see the referenced API documentation linked above. @@ -45,9 +45,9 @@ Options - 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. + - flag that indicates whether Application wraps the response in an envelope JSON object * - -h, --help - - false @@ -55,7 +55,7 @@ Options * - --orgId - string - true - - 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. + - unique 24-hexadecimal digit string that identifies the organization that contains your projects * - -o, --output - string - false @@ -67,11 +67,11 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - flag that indicates whether the response body should be in the prettyprint format * - --teamName - string - true - - Name of the team whose information you want to return. + - name of the team whose information you want to return * - --version - string - false @@ -93,8 +93,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples --------- - -.. literalinclude:: /includes/examples/atlas-api-teams-getTeamByName-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-listGroupTeams.txt b/docs/command/atlas-api-teams-listGroupTeams.txt new file mode 100644 index 0000000000..6ba19346f5 --- /dev/null +++ b/docs/command/atlas-api-teams-listGroupTeams.txt @@ -0,0 +1,110 @@ +.. _atlas-api-teams-listGroupTeams: + +============================== +atlas api teams listGroupTeams +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +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-listgroupteams. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams listGroupTeams [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 listGroupTeams + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-listGroupTeams-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-listOrgTeams.txt b/docs/command/atlas-api-teams-listOrgTeams.txt new file mode 100644 index 0000000000..a53acce634 --- /dev/null +++ b/docs/command/atlas-api-teams-listOrgTeams.txt @@ -0,0 +1,108 @@ +.. _atlas-api-teams-listOrgTeams: + +============================ +atlas api teams listOrgTeams +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all teams that belong to the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgteams. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams listOrgTeams [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. + * - -h, --help + - + - false + - help for listOrgTeams + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - --orgId + - string + - true + - 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. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-listOrgTeams-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt deleted file mode 100644 index 209851b2e7..0000000000 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-api-teams-listOrganizationTeams: - -===================================== -atlas api teams listOrganizationTeams -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all teams that belong to the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationteams. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams listOrganizationTeams [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. - * - -h, --help - - - - false - - help for listOrganizationTeams - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - --orgId - - string - - true - - 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. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-listOrganizationTeams-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt deleted file mode 100644 index fb5787fe69..0000000000 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-teams-listProjectTeams: - -================================ -atlas api teams listProjectTeams -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectteams. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams listProjectTeams [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 listProjectTeams - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-listProjectTeams-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-removeGroupTeam.txt b/docs/command/atlas-api-teams-removeGroupTeam.txt new file mode 100644 index 0000000000..5fc27c6fd4 --- /dev/null +++ b/docs/command/atlas-api-teams-removeGroupTeam.txt @@ -0,0 +1,98 @@ +.. _atlas-api-teams-removeGroupTeam: + +=============================== +atlas api teams removeGroupTeam +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams removeGroupTeam [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 removeGroupTeam + * - -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) + * - --teamId + - string + - true + - Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. + * - --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-removeGroupTeam-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt deleted file mode 100644 index 08a4b8ef23..0000000000 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-api-teams-removeProjectTeam: - -================================= -atlas api teams removeProjectTeam -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams removeProjectTeam [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 removeProjectTeam - * - -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) - * - --teamId - - string - - true - - Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. - * - --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-removeProjectTeam-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt deleted file mode 100644 index 526c12ade7..0000000000 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-teams-removeTeamUser: - -============================== -atlas api teams removeTeamUser -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes one MongoDB Cloud user from the specified team. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This endpoint is deprecated. Use Remove One MongoDB Cloud User from One Team to remove an active or pending user from a team. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeteamuser. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams removeTeamUser [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. - * - -h, --help - - - - false - - help for removeTeamUser - * - --orgId - - string - - true - - 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. - * - -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 from which you want to remove one database application user. - * - --userId - - string - - true - - Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team. - * - --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-removeTeamUser-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-teams-removeUserFromTeam.txt b/docs/command/atlas-api-teams-removeUserFromTeam.txt new file mode 100644 index 0000000000..b701e52a23 --- /dev/null +++ b/docs/command/atlas-api-teams-removeUserFromTeam.txt @@ -0,0 +1,102 @@ +.. _atlas-api-teams-removeUserFromTeam: + +================================== +atlas api teams removeUserFromTeam +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes one MongoDB Cloud user from the specified team. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: This endpoint is deprecated. Use Remove One MongoDB Cloud User from One Team to remove an active or pending user from a team. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorgteamuserfromteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams removeUserFromTeam [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - -h, --help + - + - false + - help for removeUserFromTeam + * - --orgId + - string + - true + - unique 24-hexadecimal digit string that identifies the organization that contains your projects + * - -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 from which you want to remove one database application user + * - --userId + - string + - true + - unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team + * - --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. + diff --git a/docs/command/atlas-api-teams-renameOrgTeam.txt b/docs/command/atlas-api-teams-renameOrgTeam.txt new file mode 100644 index 0000000000..2c3665a2a4 --- /dev/null +++ b/docs/command/atlas-api-teams-renameOrgTeam.txt @@ -0,0 +1,99 @@ +.. _atlas-api-teams-renameOrgTeam: + +============================= +atlas api teams renameOrgTeam +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Renames one team in the specified organization. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-renameorgteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams renameOrgTeam [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - -h, --help + - + - false + - help for renameOrgTeam + * - --orgId + - string + - true + - 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. + * - -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 that you want to rename. + * - --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. + diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt deleted file mode 100644 index 7786dc1127..0000000000 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-api-teams-renameTeam: - -========================== -atlas api teams renameTeam -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Renames one team in the specified organization. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-renameteam. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams renameTeam [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - -h, --help - - - - false - - help for renameTeam - * - --orgId - - string - - true - - 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. - * - -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 that you want to rename. - * - --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. - diff --git a/docs/command/atlas-api-teams-updateGroupTeam.txt b/docs/command/atlas-api-teams-updateGroupTeam.txt new file mode 100644 index 0000000000..cf064dcf9b --- /dev/null +++ b/docs/command/atlas-api-teams-updateGroupTeam.txt @@ -0,0 +1,101 @@ +.. _atlas-api-teams-updateGroupTeam: + +=============================== +atlas api teams updateGroupTeam +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the project roles assigned to the specified team. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupteam. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api teams updateGroupTeam [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupTeam + * - -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 update roles. + * - --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. + diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt deleted file mode 100644 index ef254bd933..0000000000 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-api-teams-updateTeamRoles: - -=============================== -atlas api teams updateTeamRoles -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the project roles assigned to the specified team. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateteamroles. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api teams updateTeamRoles [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateTeamRoles - * - -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 update roles. - * - --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. - diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index b05cf1a891..7a737f7628 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -54,35 +54,35 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - Adds one or more teams to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - 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` - 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` - Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-addGroupTeams` - Adds one or more teams to the specified project. +* :ref:`atlas-api-teams-addTeamUsers` - Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createOrgTeam` - Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteOrgTeam` - 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-getGroupTeam` - 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-getOrgTeam` - Returns one team that you identified using its unique 24-hexadecimal digit ID. * :ref:`atlas-api-teams-getTeamByName` - Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeTeamUser` - Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-listGroupTeams` - Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-listOrgTeams` - Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-removeGroupTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeUserFromTeam` - Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameOrgTeam` - Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateGroupTeam` - Updates the project roles assigned to the specified team. .. toctree:: :titlesonly: - addAllTeamsToProject - addTeamUser - createTeam - deleteTeam - getProjectTeam - getTeamById + addGroupTeams + addTeamUsers + createOrgTeam + deleteOrgTeam + getGroupTeam + getOrgTeam getTeamByName - listOrganizationTeams - listProjectTeams - removeProjectTeam - removeTeamUser - renameTeam - updateTeamRoles + listGroupTeams + listOrgTeams + removeGroupTeam + removeUserFromTeam + renameOrgTeam + updateGroupTeam diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createGroupIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createGroupIntegration.txt new file mode 100644 index 0000000000..a484acfa1c --- /dev/null +++ b/docs/command/atlas-api-thirdPartyIntegrations-createGroupIntegration.txt @@ -0,0 +1,113 @@ +.. _atlas-api-thirdPartyIntegrations-createGroupIntegration: + +======================================================= +atlas api thirdPartyIntegrations createGroupIntegration +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Adds the settings for configuring one third-party service integration. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupintegration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api thirdPartyIntegrations createGroupIntegration [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 createGroupIntegration + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --integrationType + - string + - true + - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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. + diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt deleted file mode 100644 index d4ea050bb3..0000000000 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-thirdPartyIntegrations-createThirdPartyIntegration: - -============================================================ -atlas api thirdPartyIntegrations createThirdPartyIntegration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Adds the settings for configuring one third-party service integration. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createthirdpartyintegration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api thirdPartyIntegrations createThirdPartyIntegration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createThirdPartyIntegration - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --integrationType - - string - - true - - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteGroupIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteGroupIntegration.txt new file mode 100644 index 0000000000..e7cb789734 --- /dev/null +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteGroupIntegration.txt @@ -0,0 +1,102 @@ +.. _atlas-api-thirdPartyIntegrations-deleteGroupIntegration: + +======================================================= +atlas api thirdPartyIntegrations deleteGroupIntegration +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Removes the settings that permit configuring one third-party service integration. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupintegration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api thirdPartyIntegrations deleteGroupIntegration [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 deleteGroupIntegration + * - --integrationType + - string + - true + - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. + * - -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. + * - --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-thirdPartyIntegrations-deleteGroupIntegration-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt deleted file mode 100644 index c8e130be5e..0000000000 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration: - -============================================================ -atlas api thirdPartyIntegrations deleteThirdPartyIntegration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Removes the settings that permit configuring one third-party service integration. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletethirdpartyintegration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api thirdPartyIntegrations deleteThirdPartyIntegration [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 deleteThirdPartyIntegration - * - --integrationType - - string - - true - - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - -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. - * - --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-thirdPartyIntegrations-deleteThirdPartyIntegration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getGroupIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getGroupIntegration.txt new file mode 100644 index 0000000000..3e159a8099 --- /dev/null +++ b/docs/command/atlas-api-thirdPartyIntegrations-getGroupIntegration.txt @@ -0,0 +1,102 @@ +.. _atlas-api-thirdPartyIntegrations-getGroupIntegration: + +==================================================== +atlas api thirdPartyIntegrations getGroupIntegration +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the settings for configuring integration with one third-party service. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupintegration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api thirdPartyIntegrations getGroupIntegration [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 getGroupIntegration + * - --integrationType + - string + - true + - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. + * - -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. + * - --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-thirdPartyIntegrations-getGroupIntegration-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt deleted file mode 100644 index 77a2c46d92..0000000000 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-api-thirdPartyIntegrations-getThirdPartyIntegration: - -========================================================= -atlas api thirdPartyIntegrations getThirdPartyIntegration -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the settings for configuring integration with one third-party service. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getthirdpartyintegration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api thirdPartyIntegrations getThirdPartyIntegration [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 getThirdPartyIntegration - * - --integrationType - - string - - true - - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - -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. - * - --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-thirdPartyIntegrations-getThirdPartyIntegration-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listGroupIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listGroupIntegrations.txt new file mode 100644 index 0000000000..d283f585fd --- /dev/null +++ b/docs/command/atlas-api-thirdPartyIntegrations-listGroupIntegrations.txt @@ -0,0 +1,110 @@ +.. _atlas-api-thirdPartyIntegrations-listGroupIntegrations: + +====================================================== +atlas api thirdPartyIntegrations listGroupIntegrations +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the settings that permit integrations with all configured third-party services. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupintegrations. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api thirdPartyIntegrations listGroupIntegrations [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 listGroupIntegrations + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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-thirdPartyIntegrations-listGroupIntegrations-2023-01-01-default.sh + :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt deleted file mode 100644 index 091764ba6b..0000000000 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations: - -=========================================================== -atlas api thirdPartyIntegrations listThirdPartyIntegrations -=========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns the settings that permit integrations with all configured third-party services. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listthirdpartyintegrations. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api thirdPartyIntegrations listThirdPartyIntegrations [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 listThirdPartyIntegrations - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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-thirdPartyIntegrations-listThirdPartyIntegrations-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateGroupIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateGroupIntegration.txt new file mode 100644 index 0000000000..e7590a42a8 --- /dev/null +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateGroupIntegration.txt @@ -0,0 +1,113 @@ +.. _atlas-api-thirdPartyIntegrations-updateGroupIntegration: + +======================================================= +atlas api thirdPartyIntegrations updateGroupIntegration +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates the settings for configuring integration with one third-party service. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupintegration. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api thirdPartyIntegrations updateGroupIntegration [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. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --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 updateGroupIntegration + * - --includeCount + - + - false + - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. + * - --integrationType + - string + - true + - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. + * - --itemsPerPage + - int + - false + - Number of items that the response returns per page. + * - -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) + * - --pageNum + - int + - false + - Number of the page that displays the current set of the total objects that the response returns. + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --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. + diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt deleted file mode 100644 index 04135e528c..0000000000 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration: - -============================================================ -atlas api thirdPartyIntegrations updateThirdPartyIntegration -============================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates the settings for configuring integration with one third-party service. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatethirdpartyintegration. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api thirdPartyIntegrations updateThirdPartyIntegration [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 updateThirdPartyIntegration - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --integrationType - - string - - true - - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --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. - diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index a635ea0ed9..66153a4c09 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -57,19 +57,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createGroupIntegration` - Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteGroupIntegration` - Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getGroupIntegration` - Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listGroupIntegrations` - Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateGroupIntegration` - Updates the settings for configuring integration with one third-party service. .. toctree:: :titlesonly: - createThirdPartyIntegration - deleteThirdPartyIntegration - getThirdPartyIntegration - listThirdPartyIntegrations - updateThirdPartyIntegration + createGroupIntegration + deleteGroupIntegration + getGroupIntegration + listGroupIntegrations + updateGroupIntegration diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCert.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCert.txt new file mode 100644 index 0000000000..152952c1c4 --- /dev/null +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCert.txt @@ -0,0 +1,105 @@ +.. _atlas-api-x509Authentication-createDatabaseUserCert: + +=================================================== +atlas api x509Authentication createDatabaseUserCert +=================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generates one X.509 certificate for the specified MongoDB user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. + + +If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatabaseusercert. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api x509Authentication createDatabaseUserCert [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for createDatabaseUserCert + * - -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 + * - --username + - string + - true + - human-readable label that represents the MongoDB database user account for whom to create a certificate + * - --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. + diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt deleted file mode 100644 index a7052de962..0000000000 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-api-x509Authentication-createDatabaseUserCertificate: - -========================================================== -atlas api x509Authentication createDatabaseUserCertificate -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generates one X.509 certificate for the specified MongoDB user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. - - -If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatabaseusercertificate. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api x509Authentication createDatabaseUserCertificate [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. - * - --file - - string - - false - - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. - * - --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 createDatabaseUserCertificate - * - -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. - * - --username - - string - - true - - Human-readable label that represents the MongoDB database user account for whom to create a certificate. - * - --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. - diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt deleted file mode 100644 index 8ef2b8490c..0000000000 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-api-x509Authentication-disableCustomerManagedX509: - -======================================================= -atlas api x509Authentication disableCustomerManagedX509 -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablecustomermanagedx509. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api x509Authentication disableCustomerManagedX509 [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 disableCustomerManagedX509 - * - -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) - * - --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-x509Authentication-disableCustomerManagedX509-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-x509Authentication-disableSecurityCustomerX509.txt b/docs/command/atlas-api-x509Authentication-disableSecurityCustomerX509.txt new file mode 100644 index 0000000000..22b5387ba6 --- /dev/null +++ b/docs/command/atlas-api-x509Authentication-disableSecurityCustomerX509.txt @@ -0,0 +1,87 @@ +.. _atlas-api-x509Authentication-disableSecurityCustomerX509: + +======================================================== +atlas api x509Authentication disableSecurityCustomerX509 +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupusersecuritycustomerx509. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api x509Authentication disableSecurityCustomerX509 [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for disableSecurityCustomerX509 + * - -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) + * - --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. + diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt deleted file mode 100644 index 556cf2d3ce..0000000000 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-api-x509Authentication-listDatabaseUserCertificates: - -========================================================= -atlas api x509Authentication listDatabaseUserCertificates -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all unexpired X.509 certificates for the specified MongoDB user. - -The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. -Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. - -This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusercertificates. - -For more information and examples, see the referenced API documentation linked above. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas api x509Authentication listDatabaseUserCertificates [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 listDatabaseUserCertificates - * - --includeCount - - - - false - - Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. - * - --itemsPerPage - - int - - false - - Number of items that the response returns per page. - * - -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) - * - --pageNum - - int - - false - - Number of the page that displays the current set of the total objects that the response returns. - * - --pretty - - - - false - - Flag that indicates whether the response body should be in the prettyprint format. - * - --username - - string - - true - - Human-readable label that represents the MongoDB database user account whose certificates you want to return. - * - --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-x509Authentication-listDatabaseUserCertificates-2023-01-01-default.sh - :language: shell diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCerts.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCerts.txt new file mode 100644 index 0000000000..7c02e5176f --- /dev/null +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCerts.txt @@ -0,0 +1,107 @@ +.. _atlas-api-x509Authentication-listDatabaseUserCerts: + +================================================== +atlas api x509Authentication listDatabaseUserCerts +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all unexpired X.509 certificates for the specified MongoDB user. + +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + +This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatabaseusercerts. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api x509Authentication listDatabaseUserCerts [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 + - + - false + - flag that indicates whether Application wraps the response in an envelope JSON object + * - --groupId + - string + - true + - unique 24-hexadecimal digit string that identifies your project + * - -h, --help + - + - false + - help for listDatabaseUserCerts + * - --includeCount + - + - false + - flag that indicates whether the response returns the total number of items (totalCount) in the response + * - --itemsPerPage + - int + - false + - number of items that the response returns per page + * - -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) + * - --pageNum + - int + - false + - number of the page that displays the current set of the total objects that the response returns + * - --pretty + - + - false + - flag that indicates whether the response body should be in the prettyprint format + * - --username + - string + - true + - human-readable label that represents the MongoDB database user account whose certificates you want to return + * - --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. + diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index effc72448b..fd1394d445 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -54,15 +54,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCert` - Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableSecurityCustomerX509` - Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +* :ref:`atlas-api-x509Authentication-listDatabaseUserCerts` - Returns all unexpired X.509 certificates for the specified MongoDB user. .. toctree:: :titlesonly: - createDatabaseUserCertificate - disableCustomerManagedX509 - listDatabaseUserCertificates + createDatabaseUserCert + disableSecurityCustomerX509 + listDatabaseUserCerts diff --git a/docs/command/includes/atlas-api-accessTracking-listAccessLogsByClusterName-2023-01-01-default.sh b/docs/command/includes/atlas-api-accessTracking-listAccessLogsByClusterName-2023-01-01-default.sh deleted file mode 100644 index 3512d4ada9..0000000000 --- a/docs/command/includes/atlas-api-accessTracking-listAccessLogsByClusterName-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-accessTracking-listAccessLogsByHostname-2023-01-01-default.sh b/docs/command/includes/atlas-api-accessTracking-listAccessLogsByHostname-2023-01-01-default.sh deleted file mode 100644 index 4a910d31fb..0000000000 --- a/docs/command/includes/atlas-api-accessTracking-listAccessLogsByHostname-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] diff --git a/docs/command/includes/atlas-api-alertConfigurations-deleteAlertConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-alertConfigurations-deleteAlertConfiguration-2023-01-01-default.sh deleted file mode 100644 index a7ccc46ba0..0000000000 --- a/docs/command/includes/atlas-api-alertConfigurations-deleteAlertConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alertConfigurations-getAlertConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-alertConfigurations-getAlertConfiguration-2023-01-01-default.sh deleted file mode 100644 index 5cd5da2fd8..0000000000 --- a/docs/command/includes/atlas-api-alertConfigurations-getAlertConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurations-2023-01-01-default.sh b/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurations-2023-01-01-default.sh deleted file mode 100644 index 69254d3ec0..0000000000 --- a/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurations-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId-2023-01-01-default.sh b/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId-2023-01-01-default.sh deleted file mode 100644 index 3be8a762b6..0000000000 --- a/docs/command/includes/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alerts-getAlert-2023-01-01-default.sh b/docs/command/includes/atlas-api-alerts-getAlert-2023-01-01-default.sh deleted file mode 100644 index c32fdc70ed..0000000000 --- a/docs/command/includes/atlas-api-alerts-getAlert-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alerts getAlert --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alerts-listAlerts-2023-01-01-default.sh b/docs/command/includes/atlas-api-alerts-listAlerts-2023-01-01-default.sh deleted file mode 100644 index 6c2be4f3cc..0000000000 --- a/docs/command/includes/atlas-api-alerts-listAlerts-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alerts listAlerts --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-alerts-listAlertsByAlertConfigurationId-2023-01-01-default.sh b/docs/command/includes/atlas-api-alerts-listAlertsByAlertConfigurationId-2023-01-01-default.sh deleted file mode 100644 index de2cea655c..0000000000 --- a/docs/command/includes/atlas-api-alerts-listAlertsByAlertConfigurationId-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchDeployment-2023-01-01-default.sh b/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchDeployment-2023-01-01-default.sh deleted file mode 100644 index da761a6630..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchDeployment-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch deleteAtlasSearchDeployment --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndex-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndex-2024-05-30-default.sh deleted file mode 100644 index bb3303d50f..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndex-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch deleteAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] diff --git a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexByName-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexByName-2024-05-30-default.sh deleted file mode 100644 index 588d891148..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexByName-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch deleteAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] diff --git a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated-2023-01-01-default.sh b/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated-2023-01-01-default.sh deleted file mode 100644 index d365f85f13..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch deleteAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] diff --git a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchDeployment-2025-03-12-default.sh b/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchDeployment-2025-03-12-default.sh deleted file mode 100644 index 353a87d4e4..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchDeployment-2025-03-12-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch getAtlasSearchDeployment --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndex-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndex-2024-05-30-default.sh deleted file mode 100644 index 62e1582b68..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndex-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch getAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] diff --git a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexByName-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexByName-2024-05-30-default.sh deleted file mode 100644 index 865790e1e8..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexByName-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch getAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] diff --git a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated-2023-01-01-default.sh b/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated-2023-01-01-default.sh deleted file mode 100644 index 00e5f28464..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch getAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] diff --git a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexes-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexes-2024-05-30-default.sh deleted file mode 100644 index ea2ded5e2e..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexes-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch listAtlasSearchIndexes --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesCluster-2024-05-30-default.sh b/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesCluster-2024-05-30-default.sh deleted file mode 100644 index bfff0921f3..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesCluster-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch listAtlasSearchIndexesCluster --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated-2023-01-01-default.sh b/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated-2023-01-01-default.sh deleted file mode 100644 index 9b86b797c0..0000000000 --- a/docs/command/includes/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api atlasSearch listAtlasSearchIndexesDeprecated --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-auditing-getAuditingConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-auditing-getAuditingConfiguration-2023-01-01-default.sh deleted file mode 100644 index bcc49321df..0000000000 --- a/docs/command/includes/atlas-api-auditing-getAuditingConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api auditing getAuditingConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-auditing-getGroupAuditLog-2023-01-01-default.sh b/docs/command/includes/atlas-api-auditing-getGroupAuditLog-2023-01-01-default.sh new file mode 100644 index 0000000000..2786b4f639 --- /dev/null +++ b/docs/command/includes/atlas-api-auditing-getGroupAuditLog-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api auditing getGroupAuditLog --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-awsClustersDns-getAwsCustomDns-2023-01-01-default.sh b/docs/command/includes/atlas-api-awsClustersDns-getAwsCustomDns-2023-01-01-default.sh deleted file mode 100644 index d4c6393be9..0000000000 --- a/docs/command/includes/atlas-api-awsClustersDns-getAwsCustomDns-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api awsClustersDns getAwsCustomDns --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-cancelBackupRestoreJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-cancelBackupRestoreJob-2023-01-01-default.sh deleted file mode 100644 index b20af3e7fb..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-cancelBackupRestoreJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups cancelBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws-payload.json b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws-payload.json deleted file mode 100644 index 7358709a64..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws-payload.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws.sh b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws.sh deleted file mode 100644 index 8ab4ab0bfb..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups createExportBucket --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws-payload.json b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws-payload.json deleted file mode 100644 index 7358709a64..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws-payload.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws.sh b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws.sh deleted file mode 100644 index 89dcb89186..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure-payload.json b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure-payload.json deleted file mode 100644 index dcf222372f..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure-payload.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "bucketName": "examplecontainer", - "cloudProvider": "AZURE", - "roleId": "668c5f0ed436263134491592", - "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure.sh b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure.sh deleted file mode 100644 index 89dcb89186..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp-payload.json b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp-payload.json deleted file mode 100644 index b223fed573..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp-payload.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "bucketName": "export-bucket", - "cloudProvider": "GCP", - "roleId": "668c5f0ed436263134491592" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp.sh b/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp.sh deleted file mode 100644 index 89dcb89186..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-deleteAllBackupSchedules-2024-08-05-default.sh b/docs/command/includes/atlas-api-cloudBackups-deleteAllBackupSchedules-2024-08-05-default.sh deleted file mode 100644 index 6ce7c966e9..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-deleteAllBackupSchedules-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups deleteAllBackupSchedules --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-deleteExportBucket-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-deleteExportBucket-2023-01-01-default.sh deleted file mode 100644 index c3e0ecc0b2..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-deleteExportBucket-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups deleteExportBucket --version 2023-01-01 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-deleteReplicaSetBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-deleteReplicaSetBackup-2023-01-01-default.sh deleted file mode 100644 index 4ab342a64e..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-deleteReplicaSetBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-cloudBackups-deleteShardedClusterBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-deleteShardedClusterBackup-2023-01-01-default.sh deleted file mode 100644 index 42dff83fc7..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-deleteShardedClusterBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups deleteShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-cloudBackups-disableDataProtectionSettings-2024-11-13-default.sh b/docs/command/includes/atlas-api-cloudBackups-disableDataProtectionSettings-2024-11-13-default.sh deleted file mode 100644 index ca0da10a0d..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-disableDataProtectionSettings-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups disableDataProtectionSettings --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getBackupExportJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getBackupExportJob-2023-01-01-default.sh deleted file mode 100644 index 594572b6e6..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getBackupExportJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getBackupExportJob --version 2023-01-01 --clusterName [clusterName] --exportId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getBackupRestoreJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getBackupRestoreJob-2023-01-01-default.sh deleted file mode 100644 index 0e58b7084b..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getBackupRestoreJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] diff --git a/docs/command/includes/atlas-api-cloudBackups-getBackupSchedule-2024-08-05-default.sh b/docs/command/includes/atlas-api-cloudBackups-getBackupSchedule-2024-08-05-default.sh deleted file mode 100644 index 45ec907f2f..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getBackupSchedule-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getDataProtectionSettings-2023-10-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getDataProtectionSettings-2023-10-01-default.sh deleted file mode 100644 index 1b9396c64c..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getDataProtectionSettings-2023-10-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getDataProtectionSettings --version 2023-10-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getExportBucket-2024-05-30-default.sh b/docs/command/includes/atlas-api-cloudBackups-getExportBucket-2024-05-30-default.sh deleted file mode 100644 index f6237e2d25..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getExportBucket-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getExportBucket --version 2024-05-30 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getReplicaSetBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getReplicaSetBackup-2023-01-01-default.sh deleted file mode 100644 index f0d491e81d..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getReplicaSetBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-cloudBackups-getServerlessBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getServerlessBackup-2023-01-01-default.sh deleted file mode 100644 index 82ae132b87..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getServerlessBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getServerlessBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-getServerlessBackupRestoreJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getServerlessBackupRestoreJob-2023-01-01-default.sh deleted file mode 100644 index 2cdf49fec1..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getServerlessBackupRestoreJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getServerlessBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] diff --git a/docs/command/includes/atlas-api-cloudBackups-getShardedClusterBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-getShardedClusterBackup-2023-01-01-default.sh deleted file mode 100644 index 0e3ba8d441..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-getShardedClusterBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups getShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-cloudBackups-listBackupExportJobs-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listBackupExportJobs-2023-01-01-default.sh deleted file mode 100644 index dd03c9c1c3..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listBackupExportJobs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listBackupExportJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listBackupRestoreJobs-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listBackupRestoreJobs-2023-01-01-default.sh deleted file mode 100644 index c5112cbcdb..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listBackupRestoreJobs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listExportBuckets-2024-05-30-default.sh b/docs/command/includes/atlas-api-cloudBackups-listExportBuckets-2024-05-30-default.sh deleted file mode 100644 index aba38fbaf8..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listExportBuckets-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listExportBuckets --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listReplicaSetBackups-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listReplicaSetBackups-2023-01-01-default.sh deleted file mode 100644 index 1a1177287b..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listReplicaSetBackups-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listReplicaSetBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listServerlessBackupRestoreJobs-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listServerlessBackupRestoreJobs-2023-01-01-default.sh deleted file mode 100644 index e2571d446f..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listServerlessBackupRestoreJobs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listServerlessBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listServerlessBackups-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listServerlessBackups-2023-01-01-default.sh deleted file mode 100644 index efba1f6be0..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listServerlessBackups-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listServerlessBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudBackups-listShardedClusterBackups-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudBackups-listShardedClusterBackups-2023-01-01-default.sh deleted file mode 100644 index 536949088e..0000000000 --- a/docs/command/includes/atlas-api-cloudBackups-listShardedClusterBackups-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudBackups listShardedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-cutoverMigration-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-cutoverMigration-2023-01-01-default.sh deleted file mode 100644 index 0b25c11ec8..0000000000 --- a/docs/command/includes/atlas-api-cloudMigrationService-cutoverMigration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudMigrationService cutoverMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-deleteLinkToken-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-deleteLinkToken-2023-01-01-default.sh deleted file mode 100644 index b32edcced8..0000000000 --- a/docs/command/includes/atlas-api-cloudMigrationService-deleteLinkToken-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudMigrationService deleteLinkToken --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-getGroupLiveMigration-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-getGroupLiveMigration-2023-01-01-default.sh new file mode 100644 index 0000000000..36850e5825 --- /dev/null +++ b/docs/command/includes/atlas-api-cloudMigrationService-getGroupLiveMigration-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api cloudMigrationService getGroupLiveMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-getPushMigration-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-getPushMigration-2023-01-01-default.sh deleted file mode 100644 index a3e571346f..0000000000 --- a/docs/command/includes/atlas-api-cloudMigrationService-getPushMigration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudMigrationService getPushMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-getValidationStatus-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-getValidationStatus-2023-01-01-default.sh deleted file mode 100644 index 2b3d55712e..0000000000 --- a/docs/command/includes/atlas-api-cloudMigrationService-getValidationStatus-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudMigrationService getValidationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011 diff --git a/docs/command/includes/atlas-api-cloudMigrationService-listSourceProjects-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudMigrationService-listSourceProjects-2023-01-01-default.sh deleted file mode 100644 index 0965f4035f..0000000000 --- a/docs/command/includes/atlas-api-cloudMigrationService-listSourceProjects-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudMigrationService listSourceProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole-2023-01-01-default.sh deleted file mode 100644 index 14ffe6e499..0000000000 --- a/docs/command/includes/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] diff --git a/docs/command/includes/atlas-api-cloudProviderAccess-getCloudProviderAccessRole-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudProviderAccess-getCloudProviderAccessRole-2023-01-01-default.sh deleted file mode 100644 index b781602b3f..0000000000 --- a/docs/command/includes/atlas-api-cloudProviderAccess-getCloudProviderAccessRole-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudProviderAccess getCloudProviderAccessRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] diff --git a/docs/command/includes/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles-2023-01-01-default.sh b/docs/command/includes/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles-2023-01-01-default.sh deleted file mode 100644 index ff793afded..0000000000 --- a/docs/command/includes/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api cloudProviderAccess listCloudProviderAccessRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusterOutageSimulation-endOutageSimulation-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusterOutageSimulation-endOutageSimulation-2023-01-01-default.sh deleted file mode 100644 index 16fb544fc8..0000000000 --- a/docs/command/includes/atlas-api-clusterOutageSimulation-endOutageSimulation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusterOutageSimulation endOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusterOutageSimulation-getOutageSimulation-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusterOutageSimulation-getOutageSimulation-2023-01-01-default.sh deleted file mode 100644 index 2bf3e43484..0000000000 --- a/docs/command/includes/atlas-api-clusterOutageSimulation-getOutageSimulation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusterOutageSimulation getOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-autoScalingConfiguration-2024-08-05-default.sh b/docs/command/includes/atlas-api-clusters-autoScalingConfiguration-2024-08-05-default.sh deleted file mode 100644 index 344d8d07ed..0000000000 --- a/docs/command/includes/atlas-api-clusters-autoScalingConfiguration-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters autoScalingConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster-payload.json b/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster-payload.json deleted file mode 100644 index 11c46a16ff..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster-payload.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "clusterType": "SHARDED", - "name": "myCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": false - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": false - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "diskSizeGB": 10, - "instanceSize": "M50", - "nodeCount": 3 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "diskSizeGB": 10, - "instanceSize": "M50", - "nodeCount": 0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": false - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "diskSizeGB": 10, - "instanceSize": "M30", - "nodeCount": 0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": false - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 3 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - } - ] -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster.sh b/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster.sh deleted file mode 100644 index 17b477eef3..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-08-05-cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters createCluster --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster-payload.json b/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster-payload.json deleted file mode 100644 index 7ffd1cd050..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster-payload.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "clusterType": "SHARDED", - "name": "myCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M60", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "diskSizeGB": 10, - "instanceSize": "M60", - "nodeCount": 3 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "diskSizeGB": 10, - "instanceSize": "M60", - "nodeCount": 0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "diskSizeGB": 10, - "instanceSize": "M30", - "nodeCount": 0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M60", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 3 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "diskSizeGB": 10, - "instanceSize": "M40", - "nodeCount": 0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - } - ] -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster.sh b/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster.sh deleted file mode 100644 index aba5ce5319..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters createCluster --version 2024-10-23 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster-payload.json b/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster-payload.json deleted file mode 100644 index 8693078fea..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster-payload.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "clusterType": "REPLICASET", - "name": "MyCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "electableSpecs": { - "diskSizeGB": 10, - "instanceSize": "M10", - "nodeCount": 3 - }, - "priority": 7, - "providerName": "AWS", - "regionName": "US_EAST_1" - } - ] - } - ] -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster.sh b/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster.sh deleted file mode 100644 index dfeb2fa4b5..0000000000 --- a/docs/command/includes/atlas-api-clusters-createCluster-2024-10-23-create_cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters createCluster --version 2024-10-23 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-clusters-deleteCluster-2023-02-01-delete_cluster.sh b/docs/command/includes/atlas-api-clusters-deleteCluster-2023-02-01-delete_cluster.sh deleted file mode 100644 index e7591823aa..0000000000 --- a/docs/command/includes/atlas-api-clusters-deleteCluster-2023-02-01-delete_cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-clusters-getCluster-2024-08-05-get_cluster.sh b/docs/command/includes/atlas-api-clusters-getCluster-2024-08-05-get_cluster.sh deleted file mode 100644 index bd2a0eac34..0000000000 --- a/docs/command/includes/atlas-api-clusters-getCluster-2024-08-05-get_cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-clusters-getClusterAdvancedConfiguration-2024-08-05-default.sh b/docs/command/includes/atlas-api-clusters-getClusterAdvancedConfiguration-2024-08-05-default.sh deleted file mode 100644 index da3f0024dd..0000000000 --- a/docs/command/includes/atlas-api-clusters-getClusterAdvancedConfiguration-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters getClusterAdvancedConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-getClusterStatus-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusters-getClusterStatus-2023-01-01-default.sh deleted file mode 100644 index 4c5a6986ff..0000000000 --- a/docs/command/includes/atlas-api-clusters-getClusterStatus-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-getSampleDatasetLoadStatus-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusters-getSampleDatasetLoadStatus-2023-01-01-default.sh deleted file mode 100644 index e6a79c652b..0000000000 --- a/docs/command/includes/atlas-api-clusters-getSampleDatasetLoadStatus-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters getSampleDatasetLoadStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --sampleDatasetId [sampleDatasetId] diff --git a/docs/command/includes/atlas-api-clusters-listCloudProviderRegions-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusters-listCloudProviderRegions-2023-01-01-default.sh deleted file mode 100644 index 4df694a4af..0000000000 --- a/docs/command/includes/atlas-api-clusters-listCloudProviderRegions-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters listCloudProviderRegions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-listClusters-2024-08-05-list_clusters.sh b/docs/command/includes/atlas-api-clusters-listClusters-2024-08-05-list_clusters.sh deleted file mode 100644 index 64a8b068c4..0000000000 --- a/docs/command/includes/atlas-api-clusters-listClusters-2024-08-05-list_clusters.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters listClusters --version 2024-08-05 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-clusters-loadSampleDataset-2023-01-01-default.sh b/docs/command/includes/atlas-api-clusters-loadSampleDataset-2023-01-01-default.sh deleted file mode 100644 index f567ff2bf1..0000000000 --- a/docs/command/includes/atlas-api-clusters-loadSampleDataset-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters loadSampleDataset --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-clusters-revokeMongoDbEmployeeAccess-2024-08-05-default.sh b/docs/command/includes/atlas-api-clusters-revokeMongoDbEmployeeAccess-2024-08-05-default.sh deleted file mode 100644 index b0dd40b48c..0000000000 --- a/docs/command/includes/atlas-api-clusters-revokeMongoDbEmployeeAccess-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters revokeMongoDbEmployeeAccess --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-testFailover-2023-02-01-default.sh b/docs/command/includes/atlas-api-clusters-testFailover-2023-02-01-default.sh deleted file mode 100644 index 9026eaf9c1..0000000000 --- a/docs/command/includes/atlas-api-clusters-testFailover-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters testFailover --version 2023-02-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-unpinFeatureCompatibilityVersion-2024-05-30-default.sh b/docs/command/includes/atlas-api-clusters-unpinFeatureCompatibilityVersion-2024-05-30-default.sh deleted file mode 100644 index 37619d60d0..0000000000 --- a/docs/command/includes/atlas-api-clusters-unpinFeatureCompatibilityVersion-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters unpinFeatureCompatibilityVersion --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster-payload.json b/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster-payload.json deleted file mode 100644 index d6588f59f0..0000000000 --- a/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster-payload.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "replicationSpecs": [ - { - "regionConfigs": [ - { - "electableSpecs": { - "diskSizeGB": 20, - "instanceSize": "M10", - "nodeCount": 5 - }, - "priority": 7, - "providerName": "AWS", - "regionName": "US_EAST_1" - } - ] - } - ] -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster.sh b/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster.sh deleted file mode 100644 index fef8093bd6..0000000000 --- a/docs/command/includes/atlas-api-clusters-updateCluster-2024-10-23-update_cluster.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api clusters updateCluster --version 2024-10-23 --clusterName [your-cluster-name] --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements-2023-11-15-default.sh deleted file mode 100644 index 3eb2270bee..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements-2023-11-15-default.sh deleted file mode 100644 index 73705d9e26..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics-2023-11-15-default.sh deleted file mode 100644 index b2c2874c89..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster-2023-11-15-default.sh deleted file mode 100644 index 1f534c91fc..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --groupId 32b6e34b3d91647abb20e7b8 --period PT10H diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost-2023-11-15-default.sh deleted file mode 100644 index 38c10a71af..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-collectionLevelMetrics-getPinnedNamespaces-2023-11-15-default.sh b/docs/command/includes/atlas-api-collectionLevelMetrics-getPinnedNamespaces-2023-11-15-default.sh deleted file mode 100644 index 8ac83f8355..0000000000 --- a/docs/command/includes/atlas-api-collectionLevelMetrics-getPinnedNamespaces-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api collectionLevelMetrics getPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole-2023-01-01-default.sh b/docs/command/includes/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole-2023-01-01-default.sh deleted file mode 100644 index 64b32efd1b..0000000000 --- a/docs/command/includes/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api customDatabaseRoles deleteCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] diff --git a/docs/command/includes/atlas-api-customDatabaseRoles-getCustomDatabaseRole-2023-01-01-default.sh b/docs/command/includes/atlas-api-customDatabaseRoles-getCustomDatabaseRole-2023-01-01-default.sh deleted file mode 100644 index 8de474a36e..0000000000 --- a/docs/command/includes/atlas-api-customDatabaseRoles-getCustomDatabaseRole-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api customDatabaseRoles getCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] diff --git a/docs/command/includes/atlas-api-customDatabaseRoles-listCustomDatabaseRoles-2023-01-01-default.sh b/docs/command/includes/atlas-api-customDatabaseRoles-listCustomDatabaseRoles-2023-01-01-default.sh deleted file mode 100644 index a97db48bae..0000000000 --- a/docs/command/includes/atlas-api-customDatabaseRoles-listCustomDatabaseRoles-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api customDatabaseRoles listCustomDatabaseRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 44c3f820fe..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation deleteDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-dataFederation-deleteFederatedDatabase-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-deleteFederatedDatabase-2023-01-01-default.sh deleted file mode 100644 index ea46885bd9..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-deleteFederatedDatabase-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation deleteFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit-2023-01-01-default.sh deleted file mode 100644 index f1a171360d..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation deleteOneDataFederationInstanceQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs-2023-01-01-default.sh deleted file mode 100644 index 7d69a7de98..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation downloadFederatedDatabaseQueryLogs --version 2023-01-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-dataFederation-getDataFederationPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-getDataFederationPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 41454cb549..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-getDataFederationPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation getDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-dataFederation-getFederatedDatabase-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-getFederatedDatabase-2023-01-01-default.sh deleted file mode 100644 index b6f4b2942f..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-getFederatedDatabase-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation getFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-dataFederation-listDataFederationPrivateEndpoints-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-listDataFederationPrivateEndpoints-2023-01-01-default.sh deleted file mode 100644 index d7101db6e7..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-listDataFederationPrivateEndpoints-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation listDataFederationPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-dataFederation-listFederatedDatabases-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-listFederatedDatabases-2023-01-01-default.sh deleted file mode 100644 index c060ac3576..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-listFederatedDatabases-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation listFederatedDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit-2023-01-01-default.sh deleted file mode 100644 index 4e0179f8bc..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation returnFederatedDatabaseQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits-2023-01-01-default.sh b/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits-2023-01-01-default.sh deleted file mode 100644 index 75e10b7ee6..0000000000 --- a/docs/command/includes/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api dataFederation returnFederatedDatabaseQueryLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication-payload.json deleted file mode 100644 index c1b61fd982..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "awsIAMType": "USER", - "databaseName": "$external", - "groupId": "32b6e34b3d91647abb20e7b8", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication-payload.json deleted file mode 100644 index 87ec4abe7b..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "databaseName": "admin", - "groupId": "32b6e34b3d91647abb20e7b8", - "ldapAuthType": "GROUP", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "CN=marketing,OU=groups,DC=example,DC=com" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication-payload.json deleted file mode 100644 index 15e4f8f888..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "databaseName": "admin", - "groupId": "32b6e34b3d91647abb20e7b8", - "oidcAuthType": "IDP_GROUP", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "5dd7496c7a3e5a648454341c/sales" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication-payload.json deleted file mode 100644 index 6180355cc2..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "databaseName": "$external", - "groupId": "32b6e34b3d91647abb20e7b8", - "oidcAuthType": "USER", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "5dd7496c7a3e5a648454341c/sales" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication-payload.json deleted file mode 100644 index c8025852b7..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "databaseName": "admin", - "groupId": "32b6e34b3d91647abb20e7b8", - "password": "changeme123", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "david" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication-payload.json b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication-payload.json deleted file mode 100644 index a09a03955f..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication-payload.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "databaseName": "$external", - "groupId": "32b6e34b3d91647abb20e7b8", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "CN=david@example.com,OU=users,DC=example,DC=com", - "x509Type": "CUSTOMER" -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication.sh b/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication.sh deleted file mode 100644 index b67ae2849a..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-databaseUsers-deleteDatabaseUser-2023-01-01-default.sh b/docs/command/includes/atlas-api-databaseUsers-deleteDatabaseUser-2023-01-01-default.sh deleted file mode 100644 index 3af7bfd0fe..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-deleteDatabaseUser-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName diff --git a/docs/command/includes/atlas-api-databaseUsers-getDatabaseUser-2023-01-01-default.sh b/docs/command/includes/atlas-api-databaseUsers-getDatabaseUser-2023-01-01-default.sh deleted file mode 100644 index f34d1c44fb..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-getDatabaseUser-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName diff --git a/docs/command/includes/atlas-api-databaseUsers-listDatabaseUsers-2023-01-01-default.sh b/docs/command/includes/atlas-api-databaseUsers-listDatabaseUsers-2023-01-01-default.sh deleted file mode 100644 index e2e6a4fcac..0000000000 --- a/docs/command/includes/atlas-api-databaseUsers-listDatabaseUsers-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api databaseUsers listDatabaseUsers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest-2023-01-01-default.sh b/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest-2023-01-01-default.sh deleted file mode 100644 index d2afac28c4..0000000000 --- a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 06d2c385cd..0000000000 --- a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider-2023-01-01-default.sh b/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider-2023-01-01-default.sh deleted file mode 100644 index a047069788..0000000000 --- a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion-2023-01-01-default.sh b/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion-2023-01-01-default.sh deleted file mode 100644 index d18e5ab7fe..0000000000 --- a/docs/command/includes/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-events-getGroupEvent-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-getGroupEvent-2023-01-01-default.sh new file mode 100644 index 0000000000..882294485a --- /dev/null +++ b/docs/command/includes/atlas-api-events-getGroupEvent-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api events getGroupEvent --version 2023-01-01 --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-events-getOrgEvent-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-getOrgEvent-2023-01-01-default.sh new file mode 100644 index 0000000000..7604a932d5 --- /dev/null +++ b/docs/command/includes/atlas-api-events-getOrgEvent-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api events getOrgEvent --version 2023-01-01 --eventId [eventId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-events-getOrganizationEvent-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-getOrganizationEvent-2023-01-01-default.sh deleted file mode 100644 index 9ddc67ddb7..0000000000 --- a/docs/command/includes/atlas-api-events-getOrganizationEvent-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api events getOrganizationEvent --version 2023-01-01 --eventId [eventId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-events-getProjectEvent-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-getProjectEvent-2023-01-01-default.sh deleted file mode 100644 index 4088901f34..0000000000 --- a/docs/command/includes/atlas-api-events-getProjectEvent-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api events getProjectEvent --version 2023-01-01 --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-events-listGroupEvents-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-listGroupEvents-2023-01-01-default.sh new file mode 100644 index 0000000000..2700d915aa --- /dev/null +++ b/docs/command/includes/atlas-api-events-listGroupEvents-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api events listGroupEvents --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-events-listOrgEvents-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-listOrgEvents-2023-01-01-default.sh new file mode 100644 index 0000000000..23d41bcec4 --- /dev/null +++ b/docs/command/includes/atlas-api-events-listOrgEvents-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api events listOrgEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-events-listOrganizationEvents-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-listOrganizationEvents-2023-01-01-default.sh deleted file mode 100644 index 13c135e0e8..0000000000 --- a/docs/command/includes/atlas-api-events-listOrganizationEvents-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api events listOrganizationEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-events-listProjectEvents-2023-01-01-default.sh b/docs/command/includes/atlas-api-events-listProjectEvents-2023-01-01-default.sh deleted file mode 100644 index cb8314b1ab..0000000000 --- a/docs/command/includes/atlas-api-events-listProjectEvents-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api events listProjectEvents --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationApp-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationApp-2023-01-01-default.sh deleted file mode 100644 index 9eb5197452..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationApp-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication deleteFederationApp --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e diff --git a/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationSetting-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationSetting-2023-01-01-default.sh new file mode 100644 index 0000000000..11502aaf0e --- /dev/null +++ b/docs/command/includes/atlas-api-federatedAuthentication-deleteFederationSetting-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api federatedAuthentication deleteFederationSetting --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e diff --git a/docs/command/includes/atlas-api-federatedAuthentication-deleteIdentityProvider-2023-11-15-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-deleteIdentityProvider-2023-11-15-default.sh deleted file mode 100644 index fc68ff4787..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-deleteIdentityProvider-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-deleteRoleMapping-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-deleteRoleMapping-2023-01-01-default.sh deleted file mode 100644 index b13c9240c7..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-deleteRoleMapping-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication deleteRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-getConnectedOrgConfig-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-getConnectedOrgConfig-2023-01-01-default.sh deleted file mode 100644 index 431ee7aa12..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-getConnectedOrgConfig-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-getFederationSettings-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-getFederationSettings-2023-01-01-default.sh deleted file mode 100644 index 10e606d4d0..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-getFederationSettings-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication getFederationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProvider-2023-11-15-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProvider-2023-11-15-default.sh deleted file mode 100644 index 2dbde250e7..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProvider-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProviderMetadata-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProviderMetadata-2023-01-01-default.sh deleted file mode 100644 index b8e18d5f4f..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-getIdentityProviderMetadata-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication getIdentityProviderMetadata --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId c2777a9eca931f29fc2f diff --git a/docs/command/includes/atlas-api-federatedAuthentication-getRoleMapping-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-getRoleMapping-2023-01-01-default.sh deleted file mode 100644 index 4abc5e7157..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-getRoleMapping-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication getRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-listConnectedOrgConfigs-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-listConnectedOrgConfigs-2023-01-01-default.sh deleted file mode 100644 index 8a10f0ab45..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-listConnectedOrgConfigs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e diff --git a/docs/command/includes/atlas-api-federatedAuthentication-listIdentityProviders-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-listIdentityProviders-2023-01-01-default.sh deleted file mode 100644 index 455adea9a6..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-listIdentityProviders-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e diff --git a/docs/command/includes/atlas-api-federatedAuthentication-listRoleMappings-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-listRoleMappings-2023-01-01-default.sh deleted file mode 100644 index 8a023da2b5..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-listRoleMappings-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication listRoleMappings --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-removeConnectedOrgConfig-2023-01-01-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-removeConnectedOrgConfig-2023-01-01-default.sh deleted file mode 100644 index 924b316fa3..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-removeConnectedOrgConfig-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication removeConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider-2023-11-15-default.sh b/docs/command/includes/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider-2023-11-15-default.sh deleted file mode 100644 index dc236d15eb..0000000000 --- a/docs/command/includes/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider-2023-11-15-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api federatedAuthentication revokeJwksFromIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-flexClusters-deleteFlexCluster-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexClusters-deleteFlexCluster-2024-11-13-default.sh deleted file mode 100644 index fa88e78eb4..0000000000 --- a/docs/command/includes/atlas-api-flexClusters-deleteFlexCluster-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexClusters deleteFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-flexClusters-getFlexCluster-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexClusters-getFlexCluster-2024-11-13-default.sh deleted file mode 100644 index 59ca4359e5..0000000000 --- a/docs/command/includes/atlas-api-flexClusters-getFlexCluster-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexClusters getFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-flexClusters-listFlexClusters-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexClusters-listFlexClusters-2024-11-13-default.sh deleted file mode 100644 index 851b0d1071..0000000000 --- a/docs/command/includes/atlas-api-flexClusters-listFlexClusters-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexClusters listFlexClusters --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob-2024-11-13-default.sh deleted file mode 100644 index 4c6e46fe98..0000000000 --- a/docs/command/includes/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexRestoreJobs getFlexBackupRestoreJob --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --restoreJobId [restoreJobId] diff --git a/docs/command/includes/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs-2024-11-13-default.sh deleted file mode 100644 index d3d0ae2ecc..0000000000 --- a/docs/command/includes/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexRestoreJobs listFlexBackupRestoreJobs --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-flexSnapshots-getFlexBackup-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexSnapshots-getFlexBackup-2024-11-13-default.sh deleted file mode 100644 index 30bfa3115f..0000000000 --- a/docs/command/includes/atlas-api-flexSnapshots-getFlexBackup-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexSnapshots getFlexBackup --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --snapshotId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-flexSnapshots-listFlexBackups-2024-11-13-default.sh b/docs/command/includes/atlas-api-flexSnapshots-listFlexBackups-2024-11-13-default.sh deleted file mode 100644 index e60e0b8d3d..0000000000 --- a/docs/command/includes/atlas-api-flexSnapshots-listFlexBackups-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api flexSnapshots listFlexBackups --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-globalClusters-deleteAllCustomZoneMappings-2024-08-05-default.sh b/docs/command/includes/atlas-api-globalClusters-deleteAllCustomZoneMappings-2024-08-05-default.sh deleted file mode 100644 index 3756545c00..0000000000 --- a/docs/command/includes/atlas-api-globalClusters-deleteAllCustomZoneMappings-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api globalClusters deleteAllCustomZoneMappings --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-globalClusters-deleteManagedNamespace-2024-08-05-default.sh b/docs/command/includes/atlas-api-globalClusters-deleteManagedNamespace-2024-08-05-default.sh deleted file mode 100644 index 8023fbe8fd..0000000000 --- a/docs/command/includes/atlas-api-globalClusters-deleteManagedNamespace-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api globalClusters deleteManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-globalClusters-getManagedNamespace-2024-08-05-default.sh b/docs/command/includes/atlas-api-globalClusters-getManagedNamespace-2024-08-05-default.sh deleted file mode 100644 index 21ee80b6d9..0000000000 --- a/docs/command/includes/atlas-api-globalClusters-getManagedNamespace-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api globalClusters getManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-invoices-downloadInvoiceCsv-2023-01-01-default.sh b/docs/command/includes/atlas-api-invoices-downloadInvoiceCsv-2023-01-01-default.sh deleted file mode 100644 index 54838b1c28..0000000000 --- a/docs/command/includes/atlas-api-invoices-downloadInvoiceCsv-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api invoices downloadInvoiceCsv --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-invoices-getCostExplorerQueryProcess-2023-01-01-default.sh b/docs/command/includes/atlas-api-invoices-getCostExplorerQueryProcess-2023-01-01-default.sh deleted file mode 100644 index 098fac9ef9..0000000000 --- a/docs/command/includes/atlas-api-invoices-getCostExplorerQueryProcess-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api invoices getCostExplorerQueryProcess --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --token 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C diff --git a/docs/command/includes/atlas-api-invoices-getInvoice-2023-01-01-default.sh b/docs/command/includes/atlas-api-invoices-getInvoice-2023-01-01-default.sh deleted file mode 100644 index 9aa09aa24e..0000000000 --- a/docs/command/includes/atlas-api-invoices-getInvoice-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api invoices getInvoice --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-invoices-listInvoices-2023-01-01-default.sh b/docs/command/includes/atlas-api-invoices-listInvoices-2023-01-01-default.sh deleted file mode 100644 index 837f32ef85..0000000000 --- a/docs/command/includes/atlas-api-invoices-listInvoices-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api invoices listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01 diff --git a/docs/command/includes/atlas-api-invoices-listPendingInvoices-2023-01-01-default.sh b/docs/command/includes/atlas-api-invoices-listPendingInvoices-2023-01-01-default.sh deleted file mode 100644 index 128287b365..0000000000 --- a/docs/command/includes/atlas-api-invoices-listPendingInvoices-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api invoices listPendingInvoices --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-ldapConfiguration-deleteLdapConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-ldapConfiguration-deleteLdapConfiguration-2023-01-01-default.sh deleted file mode 100644 index ff2f5908ab..0000000000 --- a/docs/command/includes/atlas-api-ldapConfiguration-deleteLdapConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api ldapConfiguration deleteLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfiguration-2023-01-01-default.sh deleted file mode 100644 index 7696c4d041..0000000000 --- a/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api ldapConfiguration getLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfigurationStatus-2023-01-01-default.sh b/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfigurationStatus-2023-01-01-default.sh deleted file mode 100644 index bcb2c62887..0000000000 --- a/docs/command/includes/atlas-api-ldapConfiguration-getLdapConfigurationStatus-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api ldapConfiguration getLdapConfigurationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --requestId [requestId] diff --git a/docs/command/includes/atlas-api-legacyBackup-deleteLegacySnapshot-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-deleteLegacySnapshot-2023-01-01-default.sh deleted file mode 100644 index 50f11371f1..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-deleteLegacySnapshot-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup deleteLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupCheckpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupCheckpoint-2023-01-01-default.sh deleted file mode 100644 index fdb6314305..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupCheckpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup getLegacyBackupCheckpoint --version 2023-01-01 --checkpointId [checkpointId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupRestoreJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupRestoreJob-2023-01-01-default.sh deleted file mode 100644 index 514d4f828e..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-getLegacyBackupRestoreJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup getLegacyBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] diff --git a/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshot-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshot-2023-01-01-default.sh deleted file mode 100644 index 22d0742179..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshot-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshotSchedule-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshotSchedule-2023-01-01-default.sh deleted file mode 100644 index d1603f0d07..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-getLegacySnapshotSchedule-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup getLegacySnapshotSchedule --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupCheckpoints-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupCheckpoints-2023-01-01-default.sh deleted file mode 100644 index ddc595b44f..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupCheckpoints-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup listLegacyBackupCheckpoints --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupRestoreJobs-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupRestoreJobs-2023-01-01-default.sh deleted file mode 100644 index b3961ecc90..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-listLegacyBackupRestoreJobs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup listLegacyBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-legacyBackup-listLegacySnapshots-2023-01-01-default.sh b/docs/command/includes/atlas-api-legacyBackup-listLegacySnapshots-2023-01-01-default.sh deleted file mode 100644 index deefdb75cb..0000000000 --- a/docs/command/includes/atlas-api-legacyBackup-listLegacySnapshots-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-maintenanceWindows-deferMaintenanceWindow-2023-01-01-default.sh b/docs/command/includes/atlas-api-maintenanceWindows-deferMaintenanceWindow-2023-01-01-default.sh deleted file mode 100644 index 37db439561..0000000000 --- a/docs/command/includes/atlas-api-maintenanceWindows-deferMaintenanceWindow-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-maintenanceWindows-getMaintenanceWindow-2023-01-01-default.sh b/docs/command/includes/atlas-api-maintenanceWindows-getMaintenanceWindow-2023-01-01-default.sh deleted file mode 100644 index 0f72b43824..0000000000 --- a/docs/command/includes/atlas-api-maintenanceWindows-getMaintenanceWindow-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api maintenanceWindows getMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-maintenanceWindows-resetMaintenanceWindow-2023-01-01-default.sh b/docs/command/includes/atlas-api-maintenanceWindows-resetMaintenanceWindow-2023-01-01-default.sh deleted file mode 100644 index 5878635a21..0000000000 --- a/docs/command/includes/atlas-api-maintenanceWindows-resetMaintenanceWindow-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api maintenanceWindows resetMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer-2023-01-01-default.sh b/docs/command/includes/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer-2023-01-01-default.sh deleted file mode 100644 index 9b672f53d5..0000000000 --- a/docs/command/includes/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api maintenanceWindows toggleMaintenanceAutoDefer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-getGroupUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-getGroupUser-2025-02-19-default.sh new file mode 100644 index 0000000000..3e68303448 --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-getGroupUser-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers getGroupUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrgUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrgUser-2025-02-19-default.sh new file mode 100644 index 0000000000..89a4d2d8dd --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrgUser-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers getOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrganizationUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrganizationUser-2025-02-19-default.sh deleted file mode 100644 index 24e58aaa52..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-getOrganizationUser-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-getProjectUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-getProjectUser-2025-02-19-default.sh deleted file mode 100644 index 35c2eb353e..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-getProjectUser-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers getProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-listGroupUsers-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-listGroupUsers-2025-02-19-default.sh new file mode 100644 index 0000000000..4214599bb0 --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-listGroupUsers-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers listGroupUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrgUsers-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrgUsers-2025-02-19-default.sh new file mode 100644 index 0000000000..2a4c0785af --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrgUsers-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers listOrgUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrganizationUsers-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrganizationUsers-2025-02-19-default.sh deleted file mode 100644 index 108f8019d8..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-listOrganizationUsers-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-listProjectUsers-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-listProjectUsers-2025-02-19-default.sh deleted file mode 100644 index 6554f026b7..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-listProjectUsers-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers listProjectUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-listTeamUsers-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-listTeamUsers-2025-02-19-default.sh deleted file mode 100644 index 5cc0ce2074..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-listTeamUsers-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers listTeamUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --teamId [teamId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeGroupUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeGroupUser-2025-02-19-default.sh new file mode 100644 index 0000000000..555fda81cb --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeGroupUser-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers removeGroupUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrgUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrgUser-2025-02-19-default.sh new file mode 100644 index 0000000000..3b95e02742 --- /dev/null +++ b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrgUser-2025-02-19-default.sh @@ -0,0 +1 @@ +atlas api mongoDbCloudUsers removeOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrganizationUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrganizationUser-2025-02-19-default.sh deleted file mode 100644 index 0d8a155260..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeOrganizationUser-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] diff --git a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeProjectUser-2025-02-19-default.sh b/docs/command/includes/atlas-api-mongoDbCloudUsers-removeProjectUser-2025-02-19-default.sh deleted file mode 100644 index 260e5b2234..0000000000 --- a/docs/command/includes/atlas-api-mongoDbCloudUsers-removeProjectUser-2025-02-19-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getAtlasProcess-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getAtlasProcess-2023-01-01-default.sh deleted file mode 100644 index 9fcc8aaec1..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getAtlasProcess-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getAtlasProcess --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getDatabase-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getDatabase-2023-01-01-default.sh deleted file mode 100644 index 6fd468fbd8..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getDatabase-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getDatabase --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getDatabaseMeasurements-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getDatabaseMeasurements-2023-01-01-default.sh deleted file mode 100644 index 71c3abad94..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getDatabaseMeasurements-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getDiskMeasurements-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getDiskMeasurements-2023-01-01-default.sh deleted file mode 100644 index 4436d359ee..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getDiskMeasurements-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getDiskMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getGroupProcess-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getGroupProcess-2023-01-01-default.sh new file mode 100644 index 0000000000..330e1cb8d8 --- /dev/null +++ b/docs/command/includes/atlas-api-monitoringAndLogs-getGroupProcess-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api monitoringAndLogs getGroupProcess --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getHostLogs-2023-02-01-get_host_logs.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getHostLogs-2023-02-01-get_host_logs.sh deleted file mode 100644 index adb7ec53fa..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getHostLogs-2023-02-01-get_host_logs.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getHostMeasurements-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getHostMeasurements-2023-01-01-default.sh deleted file mode 100644 index 23b770a3bd..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getHostMeasurements-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getHostMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getIndexMetrics-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getIndexMetrics-2023-01-01-default.sh deleted file mode 100644 index 0f87b66f43..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getIndexMetrics-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --indexName myindex --metrics [metrics] --period PT10H --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-getMeasurements-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-getMeasurements-2023-01-01-default.sh deleted file mode 100644 index 8440917671..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-getMeasurements-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs getMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listAtlasProcesses-2023-01-01-list_atlas_processes.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listAtlasProcesses-2023-01-01-list_atlas_processes.sh deleted file mode 100644 index 7b2c9622b5..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listAtlasProcesses-2023-01-01-list_atlas_processes.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listAtlasProcesses --version 2023-01-01 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listDatabases-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listDatabases-2023-01-01-default.sh deleted file mode 100644 index fbb27b61fd..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listDatabases-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listDiskMeasurements-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listDiskMeasurements-2023-01-01-default.sh deleted file mode 100644 index b89af3b78f..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listDiskMeasurements-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listDiskMeasurements --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listDiskPartitions-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listDiskPartitions-2023-01-01-default.sh deleted file mode 100644 index f9d0079251..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listDiskPartitions-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listDiskPartitions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listGroupProcesses-2023-01-01-list_atlas_processes.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listGroupProcesses-2023-01-01-list_atlas_processes.sh new file mode 100644 index 0000000000..4dad6de350 --- /dev/null +++ b/docs/command/includes/atlas-api-monitoringAndLogs-listGroupProcesses-2023-01-01-list_atlas_processes.sh @@ -0,0 +1 @@ +atlas api monitoringAndLogs listGroupProcesses --version 2023-01-01 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listIndexMetrics-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listIndexMetrics-2023-01-01-default.sh deleted file mode 100644 index ef5af06d12..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listIndexMetrics-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-monitoringAndLogs-listMetricTypes-2023-01-01-default.sh b/docs/command/includes/atlas-api-monitoringAndLogs-listMetricTypes-2023-01-01-default.sh deleted file mode 100644 index 2bfdb934ad..0000000000 --- a/docs/command/includes/atlas-api-monitoringAndLogs-listMetricTypes-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api monitoringAndLogs listMetricTypes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017 diff --git a/docs/command/includes/atlas-api-networkPeering-deleteGroupContainer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-deleteGroupContainer-2023-01-01-default.sh new file mode 100644 index 0000000000..e4347b4cdc --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-deleteGroupContainer-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering deleteGroupContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-deleteGroupPeer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-deleteGroupPeer-2023-01-01-default.sh new file mode 100644 index 0000000000..a4283fab03 --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-deleteGroupPeer-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering deleteGroupPeer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] diff --git a/docs/command/includes/atlas-api-networkPeering-deletePeeringConnection-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-deletePeeringConnection-2023-01-01-default.sh deleted file mode 100644 index 3134d1c29b..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-deletePeeringConnection-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering deletePeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] diff --git a/docs/command/includes/atlas-api-networkPeering-deletePeeringContainer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-deletePeeringContainer-2023-01-01-default.sh deleted file mode 100644 index e91dc31f3c..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-deletePeeringContainer-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering deletePeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-getGroupContainer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-getGroupContainer-2023-01-01-default.sh new file mode 100644 index 0000000000..72af14801e --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-getGroupContainer-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering getGroupContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-getGroupPeer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-getGroupPeer-2023-01-01-default.sh new file mode 100644 index 0000000000..8d03622f5c --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-getGroupPeer-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering getGroupPeer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] diff --git a/docs/command/includes/atlas-api-networkPeering-getPeeringConnection-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-getPeeringConnection-2023-01-01-default.sh deleted file mode 100644 index 9109addb73..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-getPeeringConnection-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering getPeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] diff --git a/docs/command/includes/atlas-api-networkPeering-getPeeringContainer-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-getPeeringContainer-2023-01-01-default.sh deleted file mode 100644 index b79784797a..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-getPeeringContainer-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering getPeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-listGroupContainerAll-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listGroupContainerAll-2023-01-01-default.sh new file mode 100644 index 0000000000..b4dd3e4dbb --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-listGroupContainerAll-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering listGroupContainerAll --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-listGroupContainers-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listGroupContainers-2023-01-01-default.sh new file mode 100644 index 0000000000..65a309747a --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-listGroupContainers-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering listGroupContainers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --providerName [providerName] diff --git a/docs/command/includes/atlas-api-networkPeering-listGroupPeers-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listGroupPeers-2023-01-01-default.sh new file mode 100644 index 0000000000..726cf732b7 --- /dev/null +++ b/docs/command/includes/atlas-api-networkPeering-listGroupPeers-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api networkPeering listGroupPeers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-listPeeringConnections-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listPeeringConnections-2023-01-01-default.sh deleted file mode 100644 index 95eda33afe..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-listPeeringConnections-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering listPeeringConnections --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-listPeeringContainerByCloudProvider-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listPeeringContainerByCloudProvider-2023-01-01-default.sh deleted file mode 100644 index e585486aa9..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-listPeeringContainerByCloudProvider-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering listPeeringContainerByCloudProvider --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --providerName [providerName] diff --git a/docs/command/includes/atlas-api-networkPeering-listPeeringContainers-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-listPeeringContainers-2023-01-01-default.sh deleted file mode 100644 index 7c648f5230..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-listPeeringContainers-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering listPeeringContainers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject-2023-01-01-default.sh b/docs/command/includes/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject-2023-01-01-default.sh deleted file mode 100644 index 26c6d726bc..0000000000 --- a/docs/command/includes/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-onlineArchive-deleteOnlineArchive-2023-01-01-default.sh b/docs/command/includes/atlas-api-onlineArchive-deleteOnlineArchive-2023-01-01-default.sh deleted file mode 100644 index d463ff8e0f..0000000000 --- a/docs/command/includes/atlas-api-onlineArchive-deleteOnlineArchive-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api onlineArchive deleteOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs-2023-01-01-default.sh b/docs/command/includes/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs-2023-01-01-default.sh deleted file mode 100644 index 5e84f40bca..0000000000 --- a/docs/command/includes/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09 diff --git a/docs/command/includes/atlas-api-onlineArchive-getOnlineArchive-2023-01-01-default.sh b/docs/command/includes/atlas-api-onlineArchive-getOnlineArchive-2023-01-01-default.sh deleted file mode 100644 index 823d7a566e..0000000000 --- a/docs/command/includes/atlas-api-onlineArchive-getOnlineArchive-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api onlineArchive getOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-onlineArchive-listOnlineArchives-2023-01-01-default.sh b/docs/command/includes/atlas-api-onlineArchive-listOnlineArchives-2023-01-01-default.sh deleted file mode 100644 index dc6920c9e1..0000000000 --- a/docs/command/includes/atlas-api-onlineArchive-listOnlineArchives-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api onlineArchive listOnlineArchives --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-organizations-deleteOrg-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-deleteOrg-2023-01-01-default.sh new file mode 100644 index 0000000000..a3b271afec --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-deleteOrg-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations deleteOrg --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-deleteOrgInvite-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-deleteOrgInvite-2023-01-01-default.sh new file mode 100644 index 0000000000..2d40cc6c21 --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-deleteOrgInvite-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations deleteOrgInvite --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-deleteOrganization-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-deleteOrganization-2023-01-01-default.sh deleted file mode 100644 index de80fcaf42..0000000000 --- a/docs/command/includes/atlas-api-organizations-deleteOrganization-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations deleteOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-deleteOrganizationInvitation-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-deleteOrganizationInvitation-2023-01-01-default.sh deleted file mode 100644 index b610cb9eb5..0000000000 --- a/docs/command/includes/atlas-api-organizations-deleteOrganizationInvitation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations deleteOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrg-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrg-2023-01-01-default.sh new file mode 100644 index 0000000000..c57fbdb9d3 --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-getOrg-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations getOrg --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrgGroups-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrgGroups-2023-01-01-default.sh new file mode 100644 index 0000000000..6f9e1b6d7c --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-getOrgGroups-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations getOrgGroups --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrgInvite-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrgInvite-2023-01-01-default.sh new file mode 100644 index 0000000000..22f4b0fe38 --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-getOrgInvite-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations getOrgInvite --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrgSettings-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrgSettings-2023-01-01-default.sh new file mode 100644 index 0000000000..a13c37fdc4 --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-getOrgSettings-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations getOrgSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrganization-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrganization-2023-01-01-default.sh deleted file mode 100644 index 6652f4677a..0000000000 --- a/docs/command/includes/atlas-api-organizations-getOrganization-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations getOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrganizationInvitation-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrganizationInvitation-2023-01-01-default.sh deleted file mode 100644 index 141ced36f6..0000000000 --- a/docs/command/includes/atlas-api-organizations-getOrganizationInvitation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations getOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-getOrganizationSettings-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-getOrganizationSettings-2023-01-01-default.sh deleted file mode 100644 index c241b7debb..0000000000 --- a/docs/command/includes/atlas-api-organizations-getOrganizationSettings-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations getOrganizationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-listOrgInvites-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-listOrgInvites-2023-01-01-default.sh new file mode 100644 index 0000000000..9cd14f8026 --- /dev/null +++ b/docs/command/includes/atlas-api-organizations-listOrgInvites-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api organizations listOrgInvites --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-listOrganizationInvitations-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-listOrganizationInvitations-2023-01-01-default.sh deleted file mode 100644 index 256026bde2..0000000000 --- a/docs/command/includes/atlas-api-organizations-listOrganizationInvitations-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations listOrganizationInvitations --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-organizations-listOrganizationProjects-2023-01-01-default.sh b/docs/command/includes/atlas-api-organizations-listOrganizationProjects-2023-01-01-default.sh deleted file mode 100644 index 37f7d93cd9..0000000000 --- a/docs/command/includes/atlas-api-organizations-listOrganizationProjects-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api organizations listOrganizationProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-disableSlowOperationThresholding-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-disableSlowOperationThresholding-2023-01-01-default.sh deleted file mode 100644 index 1fe2f35b5e..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-disableSlowOperationThresholding-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor disableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-enableSlowOperationThresholding-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-enableSlowOperationThresholding-2023-01-01-default.sh deleted file mode 100644 index a63f83087f..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-enableSlowOperationThresholding-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor enableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-getManagedSlowMs-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-getManagedSlowMs-2023-01-01-default.sh deleted file mode 100644 index 35b25acd36..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-getManagedSlowMs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor getManagedSlowMs --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-getServerlessAutoIndexing-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-getServerlessAutoIndexing-2023-01-01-default.sh deleted file mode 100644 index 90eee12166..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-getServerlessAutoIndexing-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor getServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listClusterSuggestedIndexes-2024-08-05-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listClusterSuggestedIndexes-2024-08-05-default.sh deleted file mode 100644 index c17e9f66fa..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listClusterSuggestedIndexes-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listDropIndexes-2024-08-05-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listDropIndexes-2024-08-05-default.sh deleted file mode 100644 index 3937770d4c..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listDropIndexes-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listDropIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listSchemaAdvice-2024-08-05-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listSchemaAdvice-2024-08-05-default.sh deleted file mode 100644 index 603a06826c..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listSchemaAdvice-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listSchemaAdvice --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueries-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueries-2023-01-01-default.sh deleted file mode 100644 index 6cda70499d..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueries-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listSlowQueries --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueryNamespaces-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueryNamespaces-2023-01-01-default.sh deleted file mode 100644 index 8379bbb678..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listSlowQueryNamespaces-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listSlowQueryNamespaces --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] diff --git a/docs/command/includes/atlas-api-performanceAdvisor-listSuggestedIndexes-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-listSuggestedIndexes-2023-01-01-default.sh deleted file mode 100644 index f914a7caa4..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-listSuggestedIndexes-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] diff --git a/docs/command/includes/atlas-api-performanceAdvisor-setServerlessAutoIndexing-2023-01-01-default.sh b/docs/command/includes/atlas-api-performanceAdvisor-setServerlessAutoIndexing-2023-01-01-default.sh deleted file mode 100644 index 8674c7ecd2..0000000000 --- a/docs/command/includes/atlas-api-performanceAdvisor-setServerlessAutoIndexing-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api performanceAdvisor setServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --enable [enable] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 91e4ac40c7..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpointService-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpointService-2023-01-01-default.sh deleted file mode 100644 index 7d2dc87e56..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-deletePrivateEndpointService-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices deletePrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 351f38e686..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices getPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpointService-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpointService-2023-01-01-default.sh deleted file mode 100644 index a60782a815..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-getPrivateEndpointService-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices getPrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting-2023-01-01-default.sh deleted file mode 100644 index 24fecdd5f6..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-privateEndpointServices-listPrivateEndpointServices-2023-01-01-default.sh b/docs/command/includes/atlas-api-privateEndpointServices-listPrivateEndpointServices-2023-01-01-default.sh deleted file mode 100644 index b0c0ed82b5..0000000000 --- a/docs/command/includes/atlas-api-privateEndpointServices-listPrivateEndpointServices-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api privateEndpointServices listPrivateEndpointServices --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKey-2023-01-01-default.sh deleted file mode 100644 index e4018aec8b..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKey-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys deleteApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry-2023-01-01-default.sh deleted file mode 100644 index 11a6c88d65..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys deleteApiKeyAccessListEntry --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-deleteOrgApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-deleteOrgApiKey-2023-01-01-default.sh new file mode 100644 index 0000000000..58470ffb9c --- /dev/null +++ b/docs/command/includes/atlas-api-programmaticApiKeys-deleteOrgApiKey-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api programmaticApiKeys deleteOrgApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-getApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-getApiKey-2023-01-01-default.sh deleted file mode 100644 index 055f0fa68c..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-getApiKey-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys getApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-getApiKeyAccessList-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-getApiKeyAccessList-2023-01-01-default.sh deleted file mode 100644 index db4fd88216..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-getApiKeyAccessList-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-getOrgApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-getOrgApiKey-2023-01-01-default.sh new file mode 100644 index 0000000000..7b920b880f --- /dev/null +++ b/docs/command/includes/atlas-api-programmaticApiKeys-getOrgApiKey-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api programmaticApiKeys getOrgApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries-2023-01-01-default.sh deleted file mode 100644 index fea69f42f3..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys listApiKeyAccessListsEntries --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeys-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeys-2023-01-01-default.sh deleted file mode 100644 index f4731b5e32..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-listApiKeys-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys listApiKeys --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-listGroupApiKeys-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-listGroupApiKeys-2023-01-01-default.sh new file mode 100644 index 0000000000..f8aad988a2 --- /dev/null +++ b/docs/command/includes/atlas-api-programmaticApiKeys-listGroupApiKeys-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api programmaticApiKeys listGroupApiKeys --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-listOrgApiKeys-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-listOrgApiKeys-2023-01-01-default.sh new file mode 100644 index 0000000000..506387234f --- /dev/null +++ b/docs/command/includes/atlas-api-programmaticApiKeys-listOrgApiKeys-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api programmaticApiKeys listOrgApiKeys --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-listProjectApiKeys-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-listProjectApiKeys-2023-01-01-default.sh deleted file mode 100644 index 7b5ed17cec..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-listProjectApiKeys-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys listProjectApiKeys --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-removeGroupApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-removeGroupApiKey-2023-01-01-default.sh new file mode 100644 index 0000000000..66dc3fe198 --- /dev/null +++ b/docs/command/includes/atlas-api-programmaticApiKeys-removeGroupApiKey-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api programmaticApiKeys removeGroupApiKey --version 2023-01-01 --apiUserId [apiUserId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-programmaticApiKeys-removeProjectApiKey-2023-01-01-default.sh b/docs/command/includes/atlas-api-programmaticApiKeys-removeProjectApiKey-2023-01-01-default.sh deleted file mode 100644 index 71c8b9dabd..0000000000 --- a/docs/command/includes/atlas-api-programmaticApiKeys-removeProjectApiKey-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api programmaticApiKeys removeProjectApiKey --version 2023-01-01 --apiUserId [apiUserId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add-payload.json b/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add-payload.json deleted file mode 100644 index 2a9ed70d97..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add-payload.json +++ /dev/null @@ -1,10 +0,0 @@ -[ - { - "cidrBlock": "192.168.1.0/24", - "comment": "Internal network range" - }, - { - "cidrBlock": "10.0.0.0/16", - "comment": "VPC network range" - } -] \ No newline at end of file diff --git a/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add.sh b/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add.sh deleted file mode 100644 index 264b3c60d1..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-projectIpAccessList-deleteProjectIpAccessList-2023-01-01-project_ip_access_list_delete.sh b/docs/command/includes/atlas-api-projectIpAccessList-deleteProjectIpAccessList-2023-01-01-project_ip_access_list_delete.sh deleted file mode 100644 index 86fa1bf2bc..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-deleteProjectIpAccessList-2023-01-01-project_ip_access_list_delete.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projectIpAccessList deleteProjectIpAccessList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpAccessListStatus-2023-01-01-project_ip_access_list_get_status.sh b/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpAccessListStatus-2023-01-01-project_ip_access_list_get_status.sh deleted file mode 100644 index 5492b66495..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpAccessListStatus-2023-01-01-project_ip_access_list_get_status.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projectIpAccessList getProjectIpAccessListStatus --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpList-2023-01-01-project_ip_access_list_get.sh b/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpList-2023-01-01-project_ip_access_list_get.sh deleted file mode 100644 index 08c1fe6901..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-getProjectIpList-2023-01-01-project_ip_access_list_get.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-projectIpAccessList-listProjectIpAccessLists-2023-01-01-project_ip_access_list_list.sh b/docs/command/includes/atlas-api-projectIpAccessList-listProjectIpAccessLists-2023-01-01-project_ip_access_list_list.sh deleted file mode 100644 index 17e07903b0..0000000000 --- a/docs/command/includes/atlas-api-projectIpAccessList-listProjectIpAccessLists-2023-01-01-project_ip_access_list_list.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projectIpAccessList listProjectIpAccessLists --version 2023-01-01 --groupId [your-project-id] diff --git a/docs/command/includes/atlas-api-projects-createProject-2023-01-01-create_project-payload.json b/docs/command/includes/atlas-api-projects-createGroup-2023-01-01-create_project-payload.json similarity index 100% rename from docs/command/includes/atlas-api-projects-createProject-2023-01-01-create_project-payload.json rename to docs/command/includes/atlas-api-projects-createGroup-2023-01-01-create_project-payload.json diff --git a/docs/command/includes/atlas-api-projects-createGroup-2023-01-01-create_project.sh b/docs/command/includes/atlas-api-projects-createGroup-2023-01-01-create_project.sh new file mode 100644 index 0000000000..15504d89f9 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-createGroup-2023-01-01-create_project.sh @@ -0,0 +1 @@ +atlas api projects createGroup --version 2023-01-01 diff --git a/docs/command/includes/atlas-api-projects-createProject-2023-01-01-create_project.sh b/docs/command/includes/atlas-api-projects-createProject-2023-01-01-create_project.sh deleted file mode 100644 index 965c462322..0000000000 --- a/docs/command/includes/atlas-api-projects-createProject-2023-01-01-create_project.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects createProject --version 2023-01-01 diff --git a/docs/command/includes/atlas-api-projects-deleteGroup-2023-01-01-delete_project.sh b/docs/command/includes/atlas-api-projects-deleteGroup-2023-01-01-delete_project.sh new file mode 100644 index 0000000000..4207ef57cd --- /dev/null +++ b/docs/command/includes/atlas-api-projects-deleteGroup-2023-01-01-delete_project.sh @@ -0,0 +1 @@ +atlas api projects deleteGroup --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-deleteGroupInvite-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-deleteGroupInvite-2023-01-01-default.sh new file mode 100644 index 0000000000..ac7f364c22 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-deleteGroupInvite-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects deleteGroupInvite --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] diff --git a/docs/command/includes/atlas-api-projects-deleteGroupLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-deleteGroupLimit-2023-01-01-default.sh new file mode 100644 index 0000000000..5b179a59c0 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-deleteGroupLimit-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects deleteGroupLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] diff --git a/docs/command/includes/atlas-api-projects-deleteProject-2023-01-01-delete_project.sh b/docs/command/includes/atlas-api-projects-deleteProject-2023-01-01-delete_project.sh deleted file mode 100644 index 14c853bac6..0000000000 --- a/docs/command/includes/atlas-api-projects-deleteProject-2023-01-01-delete_project.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects deleteProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-deleteProjectInvitation-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-deleteProjectInvitation-2023-01-01-default.sh deleted file mode 100644 index c900f57d41..0000000000 --- a/docs/command/includes/atlas-api-projects-deleteProjectInvitation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects deleteProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] diff --git a/docs/command/includes/atlas-api-projects-deleteProjectLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-deleteProjectLimit-2023-01-01-default.sh deleted file mode 100644 index 4badf4e907..0000000000 --- a/docs/command/includes/atlas-api-projects-deleteProjectLimit-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects deleteProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] diff --git a/docs/command/includes/atlas-api-projects-getGroup-2023-01-01-get_project.sh b/docs/command/includes/atlas-api-projects-getGroup-2023-01-01-get_project.sh new file mode 100644 index 0000000000..04f473bb01 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-getGroup-2023-01-01-get_project.sh @@ -0,0 +1 @@ +atlas api projects getGroup --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-getGroupInvite-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getGroupInvite-2023-01-01-default.sh new file mode 100644 index 0000000000..f7b8ead85c --- /dev/null +++ b/docs/command/includes/atlas-api-projects-getGroupInvite-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects getGroupInvite --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] diff --git a/docs/command/includes/atlas-api-projects-getGroupIpAddresses-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getGroupIpAddresses-2023-01-01-default.sh new file mode 100644 index 0000000000..28f52b0c88 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-getGroupIpAddresses-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects getGroupIpAddresses --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-getGroupLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getGroupLimit-2023-01-01-default.sh new file mode 100644 index 0000000000..0cbb1a134f --- /dev/null +++ b/docs/command/includes/atlas-api-projects-getGroupLimit-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects getGroupLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] diff --git a/docs/command/includes/atlas-api-projects-getGroupSettings-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getGroupSettings-2023-01-01-default.sh new file mode 100644 index 0000000000..5091f2cded --- /dev/null +++ b/docs/command/includes/atlas-api-projects-getGroupSettings-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects getGroupSettings --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-getProject-2023-01-01-get_project.sh b/docs/command/includes/atlas-api-projects-getProject-2023-01-01-get_project.sh deleted file mode 100644 index fb730f530e..0000000000 --- a/docs/command/includes/atlas-api-projects-getProject-2023-01-01-get_project.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects getProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-getProjectInvitation-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getProjectInvitation-2023-01-01-default.sh deleted file mode 100644 index bcf60ad2c9..0000000000 --- a/docs/command/includes/atlas-api-projects-getProjectInvitation-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects getProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] diff --git a/docs/command/includes/atlas-api-projects-getProjectLimit-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getProjectLimit-2023-01-01-default.sh deleted file mode 100644 index b0558e0468..0000000000 --- a/docs/command/includes/atlas-api-projects-getProjectLimit-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects getProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] diff --git a/docs/command/includes/atlas-api-projects-getProjectLtsVersions-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getProjectLtsVersions-2023-01-01-default.sh deleted file mode 100644 index c84c27e9d3..0000000000 --- a/docs/command/includes/atlas-api-projects-getProjectLtsVersions-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects getProjectLtsVersions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceSize M10 --itemsPerPage 100 diff --git a/docs/command/includes/atlas-api-projects-getProjectSettings-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-getProjectSettings-2023-01-01-default.sh deleted file mode 100644 index 3c1f200210..0000000000 --- a/docs/command/includes/atlas-api-projects-getProjectSettings-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects getProjectSettings --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-listGroupInvites-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-listGroupInvites-2023-01-01-default.sh new file mode 100644 index 0000000000..345b50b82b --- /dev/null +++ b/docs/command/includes/atlas-api-projects-listGroupInvites-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects listGroupInvites --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-listGroupLimits-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-listGroupLimits-2023-01-01-default.sh new file mode 100644 index 0000000000..dbe32d99a9 --- /dev/null +++ b/docs/command/includes/atlas-api-projects-listGroupLimits-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api projects listGroupLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-listGroups-2023-01-01-list_projects.sh b/docs/command/includes/atlas-api-projects-listGroups-2023-01-01-list_projects.sh new file mode 100644 index 0000000000..28b56b4d9b --- /dev/null +++ b/docs/command/includes/atlas-api-projects-listGroups-2023-01-01-list_projects.sh @@ -0,0 +1 @@ +atlas api projects listGroups --version 2023-01-01 diff --git a/docs/command/includes/atlas-api-projects-listProjectInvitations-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-listProjectInvitations-2023-01-01-default.sh deleted file mode 100644 index 361ad8003f..0000000000 --- a/docs/command/includes/atlas-api-projects-listProjectInvitations-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects listProjectInvitations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-listProjectLimits-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-listProjectLimits-2023-01-01-default.sh deleted file mode 100644 index bbffea94de..0000000000 --- a/docs/command/includes/atlas-api-projects-listProjectLimits-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects listProjectLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-listProjects-2023-01-01-list_projects.sh b/docs/command/includes/atlas-api-projects-listProjects-2023-01-01-list_projects.sh deleted file mode 100644 index d06f2912dd..0000000000 --- a/docs/command/includes/atlas-api-projects-listProjects-2023-01-01-list_projects.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects listProjects --version 2023-01-01 diff --git a/docs/command/includes/atlas-api-projects-returnAllIpAddresses-2023-01-01-default.sh b/docs/command/includes/atlas-api-projects-returnAllIpAddresses-2023-01-01-default.sh deleted file mode 100644 index a2d9f15d46..0000000000 --- a/docs/command/includes/atlas-api-projects-returnAllIpAddresses-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects returnAllIpAddresses --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-updateProject-2023-01-01-update_project-payload.json b/docs/command/includes/atlas-api-projects-updateGroup-2023-01-01-update_project-payload.json similarity index 100% rename from docs/command/includes/atlas-api-projects-updateProject-2023-01-01-update_project-payload.json rename to docs/command/includes/atlas-api-projects-updateGroup-2023-01-01-update_project-payload.json diff --git a/docs/command/includes/atlas-api-projects-updateGroup-2023-01-01-update_project.sh b/docs/command/includes/atlas-api-projects-updateGroup-2023-01-01-update_project.sh new file mode 100644 index 0000000000..0e552d70ed --- /dev/null +++ b/docs/command/includes/atlas-api-projects-updateGroup-2023-01-01-update_project.sh @@ -0,0 +1 @@ +atlas api projects updateGroup --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-projects-updateProject-2023-01-01-update_project.sh b/docs/command/includes/atlas-api-projects-updateProject-2023-01-01-update_project.sh deleted file mode 100644 index 8cb437cff4..0000000000 --- a/docs/command/includes/atlas-api-projects-updateProject-2023-01-01-update_project.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api projects updateProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration-2023-01-01-default.sh deleted file mode 100644 index bd8ccd3806..0000000000 --- a/docs/command/includes/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api pushBasedLogExport deletePushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration-2023-01-01-default.sh b/docs/command/includes/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration-2023-01-01-default.sh deleted file mode 100644 index 2ef314d27c..0000000000 --- a/docs/command/includes/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api pushBasedLogExport getPushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 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 deleted file mode 100644 index fa13997732..0000000000 --- a/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh +++ /dev/null @@ -1 +0,0 @@ -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 deleted file mode 100644 index 536a568a9e..0000000000 --- a/docs/command/includes/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-resourcePolicies-getResourcesNonCompliant-2024-08-05-default.sh b/docs/command/includes/atlas-api-resourcePolicies-getResourcesNonCompliant-2024-08-05-default.sh deleted file mode 100644 index 00430122ef..0000000000 --- a/docs/command/includes/atlas-api-resourcePolicies-getResourcesNonCompliant-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api resourcePolicies getResourcesNonCompliant --version 2024-08-05 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index-payload.json b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index-payload.json deleted file mode 100644 index c38d396ffe..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index-payload.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "property_type": "1" - } - ], - "options": { - "name": "PartialIndexTest", - "partialFilterExpression": { - "limit": { - "$gt": 900 - } - } - } -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index.sh b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index.sh deleted file mode 100644 index 34923a5b9a..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index-payload.json b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index-payload.json deleted file mode 100644 index c38d396ffe..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index-payload.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "property_type": "1" - } - ], - "options": { - "name": "PartialIndexTest", - "partialFilterExpression": { - "limit": { - "$gt": 900 - } - } - } -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index.sh b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index.sh deleted file mode 100644 index 34923a5b9a..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index-payload.json b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index-payload.json deleted file mode 100644 index 1e2ddd1b54..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index-payload.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "test_field": "1" - } - ], - "options": { - "name": "SparseIndexTest", - "sparse": true - } -} \ No newline at end of file diff --git a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index.sh b/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index.sh deleted file mode 100644 index 34923a5b9a..0000000000 --- a/docs/command/includes/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serverlessInstances-deleteServerlessInstance-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessInstances-deleteServerlessInstance-2023-01-01-default.sh deleted file mode 100644 index 3cacdaa212..0000000000 --- a/docs/command/includes/atlas-api-serverlessInstances-deleteServerlessInstance-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessInstances deleteServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-serverlessInstances-getServerlessInstance-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessInstances-getServerlessInstance-2023-01-01-default.sh deleted file mode 100644 index b1a4f42edc..0000000000 --- a/docs/command/includes/atlas-api-serverlessInstances-getServerlessInstance-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessInstances getServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] diff --git a/docs/command/includes/atlas-api-serverlessInstances-listServerlessInstances-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessInstances-listServerlessInstances-2023-01-01-default.sh deleted file mode 100644 index f8951afcbb..0000000000 --- a/docs/command/includes/atlas-api-serverlessInstances-listServerlessInstances-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessInstances listServerlessInstances --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 7e1284982c..0000000000 --- a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] diff --git a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint-2023-01-01-default.sh deleted file mode 100644 index 58fcb025c2..0000000000 --- a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] diff --git a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints-2023-01-01-default.sh b/docs/command/includes/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints-2023-01-01-default.sh deleted file mode 100644 index 569dc30ef6..0000000000 --- a/docs/command/includes/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteGroupServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteGroupServiceAccount-2024-08-05-default.sh new file mode 100644 index 0000000000..75e9c431f3 --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-deleteGroupServiceAccount-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts deleteGroupServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteOrgServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteOrgServiceAccount-2024-08-05-default.sh new file mode 100644 index 0000000000..1c288c2b2f --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-deleteOrgServiceAccount-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts deleteOrgServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccount-2024-08-05-default.sh deleted file mode 100644 index 39c33826f8..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccount-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry-2024-08-05-default.sh deleted file mode 100644 index 686dd51324..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret-2024-08-05-default.sh deleted file mode 100644 index 293138f4dd..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteProjectServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --secretId [secretId] diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccount-2024-08-05-default.sh deleted file mode 100644 index 7dce7fe0dc..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccount-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry-2024-08-05-default.sh deleted file mode 100644 index 11f4708417..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountSecret-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountSecret-2024-08-05-default.sh deleted file mode 100644 index 83a2f93ed3..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-deleteServiceAccountSecret-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts deleteServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 --secretId [secretId] diff --git a/docs/command/includes/atlas-api-serviceAccounts-getGroupServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-getGroupServiceAccount-2024-08-05-default.sh new file mode 100644 index 0000000000..55ce1a1323 --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-getGroupServiceAccount-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts getGroupServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-getOrgServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-getOrgServiceAccount-2024-08-05-default.sh new file mode 100644 index 0000000000..3ad3571d98 --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-getOrgServiceAccount-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts getOrgServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-getProjectServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-getProjectServiceAccount-2024-08-05-default.sh deleted file mode 100644 index 8dcd191f01..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-getProjectServiceAccount-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts getProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-getServiceAccount-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-getServiceAccount-2024-08-05-default.sh deleted file mode 100644 index 5a9b6c2348..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-getServiceAccount-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts getServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listGroupServiceAccounts-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listGroupServiceAccounts-2024-08-05-default.sh new file mode 100644 index 0000000000..0dcc4f6115 --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-listGroupServiceAccounts-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts listGroupServiceAccounts --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listOrgServiceAccounts-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listOrgServiceAccounts-2024-08-05-default.sh new file mode 100644 index 0000000000..d7060553c1 --- /dev/null +++ b/docs/command/includes/atlas-api-serviceAccounts-listOrgServiceAccounts-2024-08-05-default.sh @@ -0,0 +1 @@ +atlas api serviceAccounts listOrgServiceAccounts --version 2024-08-05 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccountAccessList-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccountAccessList-2024-08-05-default.sh deleted file mode 100644 index 4796f132ca..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccountAccessList-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts listProjectServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccounts-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccounts-2024-08-05-default.sh deleted file mode 100644 index 046d42bca5..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-listProjectServiceAccounts-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts listProjectServiceAccounts --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountAccessList-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountAccessList-2024-08-05-default.sh deleted file mode 100644 index 2304bc102a..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountAccessList-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts listServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountProjects-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountProjects-2024-08-05-default.sh deleted file mode 100644 index cdea4b4bb8..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccountProjects-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts listServiceAccountProjects --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccounts-2024-08-05-default.sh b/docs/command/includes/atlas-api-serviceAccounts-listServiceAccounts-2024-08-05-default.sh deleted file mode 100644 index 27e09b128f..0000000000 --- a/docs/command/includes/atlas-api-serviceAccounts-listServiceAccounts-2024-08-05-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api serviceAccounts listServiceAccounts --version 2024-08-05 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob-2023-01-01-default.sh b/docs/command/includes/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob-2023-01-01-default.sh deleted file mode 100644 index 7c037bfe47..0000000000 --- a/docs/command/includes/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreId [restoreId] diff --git a/docs/command/includes/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs-2023-01-01-default.sh b/docs/command/includes/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs-2023-01-01-default.sh deleted file mode 100644 index 64d7674817..0000000000 --- a/docs/command/includes/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-sharedTierSnapshots-getSharedClusterBackup-2023-01-01-default.sh b/docs/command/includes/atlas-api-sharedTierSnapshots-getSharedClusterBackup-2023-01-01-default.sh deleted file mode 100644 index 0ecff624e9..0000000000 --- a/docs/command/includes/atlas-api-sharedTierSnapshots-getSharedClusterBackup-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api sharedTierSnapshots getSharedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] diff --git a/docs/command/includes/atlas-api-sharedTierSnapshots-listSharedClusterBackups-2023-01-01-default.sh b/docs/command/includes/atlas-api-sharedTierSnapshots-listSharedClusterBackups-2023-01-01-default.sh deleted file mode 100644 index ca92fcde95..0000000000 --- a/docs/command/includes/atlas-api-sharedTierSnapshots-listSharedClusterBackups-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api sharedTierSnapshots listSharedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-deletePrivateLinkConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-deletePrivateLinkConnection-2023-02-01-default.sh deleted file mode 100644 index 621f201799..0000000000 --- a/docs/command/includes/atlas-api-streams-deletePrivateLinkConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams deletePrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-deleteStreamConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-deleteStreamConnection-2023-02-01-default.sh deleted file mode 100644 index 8a617af783..0000000000 --- a/docs/command/includes/atlas-api-streams-deleteStreamConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams deleteStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-deleteStreamInstance-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-deleteStreamInstance-2023-02-01-default.sh deleted file mode 100644 index 0b43cb763b..0000000000 --- a/docs/command/includes/atlas-api-streams-deleteStreamInstance-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams deleteStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-deleteStreamProcessor-2024-05-30-default.sh b/docs/command/includes/atlas-api-streams-deleteStreamProcessor-2024-05-30-default.sh deleted file mode 100644 index 08feba8be3..0000000000 --- a/docs/command/includes/atlas-api-streams-deleteStreamProcessor-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams deleteStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-deleteVpcPeeringConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-deleteVpcPeeringConnection-2023-02-01-default.sh deleted file mode 100644 index 4215d8e43d..0000000000 --- a/docs/command/includes/atlas-api-streams-deleteVpcPeeringConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams deleteVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] diff --git a/docs/command/includes/atlas-api-streams-downloadStreamTenantAuditLogs-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-downloadStreamTenantAuditLogs-2023-02-01-default.sh deleted file mode 100644 index 24578a729f..0000000000 --- a/docs/command/includes/atlas-api-streams-downloadStreamTenantAuditLogs-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams downloadStreamTenantAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-getAccountDetails-2024-11-13-default.sh b/docs/command/includes/atlas-api-streams-getAccountDetails-2024-11-13-default.sh deleted file mode 100644 index c446c43bef..0000000000 --- a/docs/command/includes/atlas-api-streams-getAccountDetails-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName] diff --git a/docs/command/includes/atlas-api-streams-getActiveVpcPeeringConnections-2024-11-13-default.sh b/docs/command/includes/atlas-api-streams-getActiveVpcPeeringConnections-2024-11-13-default.sh deleted file mode 100644 index 74b47892e5..0000000000 --- a/docs/command/includes/atlas-api-streams-getActiveVpcPeeringConnections-2024-11-13-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getActiveVpcPeeringConnections --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-getPrivateLinkConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-getPrivateLinkConnection-2023-02-01-default.sh deleted file mode 100644 index 98c2c93833..0000000000 --- a/docs/command/includes/atlas-api-streams-getPrivateLinkConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getPrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-getStreamConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-getStreamConnection-2023-02-01-default.sh deleted file mode 100644 index cc3ec4a666..0000000000 --- a/docs/command/includes/atlas-api-streams-getStreamConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-getStreamInstance-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-getStreamInstance-2023-02-01-default.sh deleted file mode 100644 index 0f9cf050be..0000000000 --- a/docs/command/includes/atlas-api-streams-getStreamInstance-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-getStreamProcessor-2024-05-30-default.sh b/docs/command/includes/atlas-api-streams-getStreamProcessor-2024-05-30-default.sh deleted file mode 100644 index bd9a4d2f4e..0000000000 --- a/docs/command/includes/atlas-api-streams-getStreamProcessor-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-getVpcPeeringConnections-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-getVpcPeeringConnections-2023-02-01-default.sh deleted file mode 100644 index e6e1c5984b..0000000000 --- a/docs/command/includes/atlas-api-streams-getVpcPeeringConnections-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams getVpcPeeringConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --requesterAccountId [requesterAccountId] diff --git a/docs/command/includes/atlas-api-streams-listPrivateLinkConnections-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-listPrivateLinkConnections-2023-02-01-default.sh deleted file mode 100644 index 60529815b0..0000000000 --- a/docs/command/includes/atlas-api-streams-listPrivateLinkConnections-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams listPrivateLinkConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-listStreamConnections-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-listStreamConnections-2023-02-01-default.sh deleted file mode 100644 index b45e11eeb4..0000000000 --- a/docs/command/includes/atlas-api-streams-listStreamConnections-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams listStreamConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-listStreamInstances-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-listStreamInstances-2023-02-01-default.sh deleted file mode 100644 index 69bea15932..0000000000 --- a/docs/command/includes/atlas-api-streams-listStreamInstances-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams listStreamInstances --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-streams-listStreamProcessors-2024-05-30-default.sh b/docs/command/includes/atlas-api-streams-listStreamProcessors-2024-05-30-default.sh deleted file mode 100644 index 0d4384c9a8..0000000000 --- a/docs/command/includes/atlas-api-streams-listStreamProcessors-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams listStreamProcessors --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-rejectVpcPeeringConnection-2023-02-01-default.sh b/docs/command/includes/atlas-api-streams-rejectVpcPeeringConnection-2023-02-01-default.sh deleted file mode 100644 index 433f68e30e..0000000000 --- a/docs/command/includes/atlas-api-streams-rejectVpcPeeringConnection-2023-02-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams rejectVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] diff --git a/docs/command/includes/atlas-api-streams-startStreamProcessor-2024-05-30-default.sh b/docs/command/includes/atlas-api-streams-startStreamProcessor-2024-05-30-default.sh deleted file mode 100644 index de52f684c0..0000000000 --- a/docs/command/includes/atlas-api-streams-startStreamProcessor-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams startStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-streams-stopStreamProcessor-2024-05-30-default.sh b/docs/command/includes/atlas-api-streams-stopStreamProcessor-2024-05-30-default.sh deleted file mode 100644 index 8189ef9796..0000000000 --- a/docs/command/includes/atlas-api-streams-stopStreamProcessor-2024-05-30-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api streams stopStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] diff --git a/docs/command/includes/atlas-api-teams-deleteOrgTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-deleteOrgTeam-2023-01-01-default.sh new file mode 100644 index 0000000000..55827d4989 --- /dev/null +++ b/docs/command/includes/atlas-api-teams-deleteOrgTeam-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams deleteOrgTeam --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-deleteTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-deleteTeam-2023-01-01-default.sh deleted file mode 100644 index 1252510ea0..0000000000 --- a/docs/command/includes/atlas-api-teams-deleteTeam-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams deleteTeam --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-getGroupTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-getGroupTeam-2023-01-01-default.sh new file mode 100644 index 0000000000..3665e79778 --- /dev/null +++ b/docs/command/includes/atlas-api-teams-getGroupTeam-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams getGroupTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-getOrgTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-getOrgTeam-2023-01-01-default.sh new file mode 100644 index 0000000000..5950181a41 --- /dev/null +++ b/docs/command/includes/atlas-api-teams-getOrgTeam-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams getOrgTeam --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] 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 deleted file mode 100644 index 51a438290f..0000000000 --- a/docs/command/includes/atlas-api-teams-getProjectTeam-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams getProjectTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-getTeamById-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-getTeamById-2023-01-01-default.sh deleted file mode 100644 index bde5a6882f..0000000000 --- a/docs/command/includes/atlas-api-teams-getTeamById-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams getTeamById --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-getTeamByName-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-getTeamByName-2023-01-01-default.sh deleted file mode 100644 index 90c1052205..0000000000 --- a/docs/command/includes/atlas-api-teams-getTeamByName-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams getTeamByName --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamName [teamName] diff --git a/docs/command/includes/atlas-api-teams-listGroupTeams-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-listGroupTeams-2023-01-01-default.sh new file mode 100644 index 0000000000..61ff51d483 --- /dev/null +++ b/docs/command/includes/atlas-api-teams-listGroupTeams-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams listGroupTeams --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-teams-listOrgTeams-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-listOrgTeams-2023-01-01-default.sh new file mode 100644 index 0000000000..399367f2ca --- /dev/null +++ b/docs/command/includes/atlas-api-teams-listOrgTeams-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams listOrgTeams --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-teams-listOrganizationTeams-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-listOrganizationTeams-2023-01-01-default.sh deleted file mode 100644 index a0a36ad95f..0000000000 --- a/docs/command/includes/atlas-api-teams-listOrganizationTeams-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams listOrganizationTeams --version 2023-01-01 --orgId 4888442a3354817a7320eb61 diff --git a/docs/command/includes/atlas-api-teams-listProjectTeams-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-listProjectTeams-2023-01-01-default.sh deleted file mode 100644 index e5aad39aa0..0000000000 --- a/docs/command/includes/atlas-api-teams-listProjectTeams-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams listProjectTeams --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-teams-removeGroupTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-removeGroupTeam-2023-01-01-default.sh new file mode 100644 index 0000000000..92a1eab0e3 --- /dev/null +++ b/docs/command/includes/atlas-api-teams-removeGroupTeam-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api teams removeGroupTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-removeProjectTeam-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-removeProjectTeam-2023-01-01-default.sh deleted file mode 100644 index b80d378b9f..0000000000 --- a/docs/command/includes/atlas-api-teams-removeProjectTeam-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams removeProjectTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] diff --git a/docs/command/includes/atlas-api-teams-removeTeamUser-2023-01-01-default.sh b/docs/command/includes/atlas-api-teams-removeTeamUser-2023-01-01-default.sh deleted file mode 100644 index b1911b5b9c..0000000000 --- a/docs/command/includes/atlas-api-teams-removeTeamUser-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api teams removeTeamUser --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] --userId [userId] diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteGroupIntegration-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteGroupIntegration-2023-01-01-default.sh new file mode 100644 index 0000000000..0719b7b033 --- /dev/null +++ b/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteGroupIntegration-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api thirdPartyIntegrations deleteGroupIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration-2023-01-01-default.sh deleted file mode 100644 index 9ac8d12a14..0000000000 --- a/docs/command/includes/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api thirdPartyIntegrations deleteThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-getGroupIntegration-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-getGroupIntegration-2023-01-01-default.sh new file mode 100644 index 0000000000..385fb7cb3c --- /dev/null +++ b/docs/command/includes/atlas-api-thirdPartyIntegrations-getGroupIntegration-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api thirdPartyIntegrations getGroupIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration-2023-01-01-default.sh deleted file mode 100644 index 173918be2d..0000000000 --- a/docs/command/includes/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api thirdPartyIntegrations getThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-listGroupIntegrations-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-listGroupIntegrations-2023-01-01-default.sh new file mode 100644 index 0000000000..299fd23f09 --- /dev/null +++ b/docs/command/includes/atlas-api-thirdPartyIntegrations-listGroupIntegrations-2023-01-01-default.sh @@ -0,0 +1 @@ +atlas api thirdPartyIntegrations listGroupIntegrations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations-2023-01-01-default.sh b/docs/command/includes/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations-2023-01-01-default.sh deleted file mode 100644 index 837ca0651c..0000000000 --- a/docs/command/includes/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api thirdPartyIntegrations listThirdPartyIntegrations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-x509Authentication-disableCustomerManagedX509-2023-01-01-default.sh b/docs/command/includes/atlas-api-x509Authentication-disableCustomerManagedX509-2023-01-01-default.sh deleted file mode 100644 index fc597810c6..0000000000 --- a/docs/command/includes/atlas-api-x509Authentication-disableCustomerManagedX509-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api x509Authentication disableCustomerManagedX509 --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/atlas-api-x509Authentication-listDatabaseUserCertificates-2023-01-01-default.sh b/docs/command/includes/atlas-api-x509Authentication-listDatabaseUserCertificates-2023-01-01-default.sh deleted file mode 100644 index 909594e7d4..0000000000 --- a/docs/command/includes/atlas-api-x509Authentication-listDatabaseUserCertificates-2023-01-01-default.sh +++ /dev/null @@ -1 +0,0 @@ -atlas api x509Authentication listDatabaseUserCertificates --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --username [username] diff --git a/internal/api/commands.go b/internal/api/commands.go index 71aac85209..0f4f077a27 100644 --- a/internal/api/commands.go +++ b/internal/api/commands.go @@ -29,14 +29,14 @@ var Commands = shared_api.GroupedAndSortedCommands{ Description: `Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.`, Commands: []shared_api.Command{ { - OperationID: `getAwsCustomDns`, - ShortOperationID: ``, + OperationID: `getGroupAwsCustomDns`, + ShortOperationID: `getAwsCustomDns`, Aliases: nil, Description: `Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getawscustomdns. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupawscustomdns. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-getAwsCustomDns/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-getGroupAwsCustomDns/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/awsCustomDNS`, QueryParameters: []shared_api.Parameter{ @@ -90,14 +90,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `toggleAwsCustomDns`, - ShortOperationID: ``, + OperationID: `toggleGroupAwsCustomDns`, + ShortOperationID: `toggleAwsCustomDns`, Aliases: nil, Description: `Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleawscustomdns. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupawscustomdns. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-toggleAwsCustomDns/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-toggleGroupAwsCustomDns/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/awsCustomDNS`, QueryParameters: []shared_api.Parameter{ @@ -157,14 +157,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.`, Commands: []shared_api.Command{ { - OperationID: `listAccessLogsByClusterName`, - ShortOperationID: ``, + OperationID: `getGroupDbAccessHistoryCluster`, + ShortOperationID: `getAccessHistoryCluster`, Aliases: nil, Description: `Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyclustername. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistorycluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-listAccessLogsByClusterName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-getGroupDbAccessHistoryCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}`, QueryParameters: []shared_api.Parameter{ @@ -278,14 +278,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAccessLogsByHostname`, - ShortOperationID: ``, + OperationID: `getGroupDbAccessHistoryProcess`, + ShortOperationID: `getAccessHistoryProcess`, Aliases: nil, Description: `Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyhostname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistoryprocess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-listAccessLogsByHostname/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-getGroupDbAccessHistoryProcess/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}`, QueryParameters: []shared_api.Parameter{ @@ -405,17 +405,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.`, Commands: []shared_api.Command{ { - OperationID: `createAlertConfiguration`, - ShortOperationID: ``, + OperationID: `createGroupAlertConfig`, + ShortOperationID: `createAlertConfig`, Aliases: nil, Description: `Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createalertconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupalertconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-createAlertConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-createGroupAlertConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alertConfigs`, QueryParameters: []shared_api.Parameter{ @@ -469,17 +469,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAlertConfiguration`, - ShortOperationID: ``, + OperationID: `deleteGroupAlertConfig`, + ShortOperationID: `deleteAlertConfig`, Aliases: nil, Description: `Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletealertconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupalertconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-deleteAlertConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-deleteGroupAlertConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}`, QueryParameters: []shared_api.Parameter{ @@ -543,19 +543,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAlertConfiguration`, - ShortOperationID: ``, + OperationID: `getGroupAlertAlertConfigs`, + ShortOperationID: `getAlertConfigs`, Aliases: nil, - Description: `Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. + Description: `Returns all alert configurations set for the specified alert. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getalertconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertalertconfigs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-getAlertConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-getGroupAlertAlertConfigs/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}`, + URL: `/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -577,6 +577,36 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, }, URLParameters: []shared_api.Parameter{ { @@ -594,8 +624,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `alertConfigId`, - Description: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + Name: `alertId`, + Description: `Unique 24-hexadecimal digit string that identifies the alert.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -617,16 +647,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAlertConfigurationMatchersFieldNames`, - ShortOperationID: ``, + OperationID: `getGroupAlertConfig`, + ShortOperationID: `getAlertConfig`, Aliases: nil, - Description: `Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. + Description: `Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurationmatchersfieldnames. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames/`, +This resource remains under revision and may change. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertconfig. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-getGroupAlertConfig/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/alertConfigs/matchers/fieldNames`, + URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -649,8 +682,33 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - URLParameters: []shared_api.Parameter{}, - Verb: http.MethodGet, + 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: `alertConfigId`, + Description: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -663,19 +721,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listAlertConfigurations`, - ShortOperationID: ``, + OperationID: `listAlertConfigMatcherFieldNames`, + ShortOperationID: `listMatcherFieldNames`, Aliases: nil, - Description: `Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - - -This resource remains under revision and may change. + Description: `Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurations. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigmatcherfieldnames. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurations/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigMatcherFieldNames/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/alertConfigs`, + URL: `/api/atlas/v2/alertConfigs/matchers/fieldNames`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -687,36 +742,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, { Name: `pretty`, Description: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -728,23 +753,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - 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`}, - }, - }, - Verb: http.MethodGet, + URLParameters: []shared_api.Parameter{}, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -757,19 +767,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAlertConfigurationsByAlertId`, - ShortOperationID: ``, + OperationID: `listGroupAlertConfigs`, + ShortOperationID: `listAlertConfigs`, Aliases: nil, - Description: `Returns all alert configurations set for the specified alert. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. + Description: `Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertconfigurationsbyalertid. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupalertconfigs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listGroupAlertConfigs/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs`, + URL: `/api/atlas/v2/groups/{groupId}/alertConfigs`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -781,16 +791,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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: `includeCount`, Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, @@ -821,6 +821,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `int`, }, }, + { + 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{ { @@ -837,16 +847,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `alertId`, - Description: `Unique 24-hexadecimal digit string that identifies the alert.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -861,8 +861,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `toggleAlertConfiguration`, - ShortOperationID: ``, + OperationID: `toggleGroupAlertConfig`, + ShortOperationID: `toggleAlertConfig`, Aliases: nil, Description: `Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -872,9 +872,9 @@ NOTE: This endpoint updates only the enabled/disabled state for the alert config This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglealertconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupalertconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-toggleAlertConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-toggleGroupAlertConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}`, QueryParameters: []shared_api.Parameter{ @@ -938,8 +938,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateAlertConfiguration`, - ShortOperationID: ``, + OperationID: `updateGroupAlertConfig`, + ShortOperationID: `updateAlertConfig`, Aliases: nil, Description: `Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -949,9 +949,9 @@ NOTE: To enable or disable the alert configuration, see Toggle One State of One This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatealertconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupalertconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-updateAlertConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-updateGroupAlertConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}`, QueryParameters: []shared_api.Parameter{ @@ -1021,17 +1021,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.`, Commands: []shared_api.Command{ { - OperationID: `acknowledgeAlert`, - ShortOperationID: ``, + OperationID: `acknowledgeGroupAlert`, + ShortOperationID: `acknowledgeAlert`, Aliases: nil, Description: `Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acknowledgealert. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acknowledgegroupalert. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-acknowledgeAlert/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-acknowledgeGroupAlert/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alerts/{alertId}`, QueryParameters: []shared_api.Parameter{ @@ -1102,17 +1102,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAlert`, - ShortOperationID: ``, + OperationID: `getGroupAlert`, + ShortOperationID: `getAlert`, Aliases: nil, Description: `Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getalert. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalert. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-getAlert/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-getGroupAlert/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/alerts/{alertId}`, QueryParameters: []shared_api.Parameter{ @@ -1176,19 +1176,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAlerts`, - ShortOperationID: ``, + OperationID: `getGroupAlertConfigAlerts`, + ShortOperationID: `getAlertConfigAlerts`, Aliases: nil, - Description: `Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalerts. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupalertconfigalerts. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-listAlerts/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-getGroupAlertConfigAlerts/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/alerts`, + URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -1240,16 +1240,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `status`, - Description: `Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -1266,6 +1256,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `alertConfigId`, + Description: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -1280,19 +1280,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAlertsByAlertConfigurationId`, - ShortOperationID: ``, + OperationID: `listGroupAlerts`, + ShortOperationID: `listAlerts`, Aliases: nil, - Description: `Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. + Description: `Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertsbyalertconfigurationid. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupalerts. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-listAlertsByAlertConfigurationId/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-listGroupAlerts/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts`, + URL: `/api/atlas/v2/groups/{groupId}/alerts`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -1344,6 +1344,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `status`, + Description: `Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, URLParameters: []shared_api.Parameter{ { @@ -1360,16 +1370,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `alertConfigId`, - Description: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -1390,16 +1390,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.`, Commands: []shared_api.Command{ { - OperationID: `createAtlasSearchDeployment`, - ShortOperationID: ``, + OperationID: `createGroupClusterFtsIndex`, + ShortOperationID: `createClusterFtsIndex`, Aliases: nil, - Description: `Creates Search Nodes for the specified cluster. + Description: `Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchdeployment. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterftsindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchDeployment/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createGroupClusterFtsIndex/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -1439,7 +1439,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Label that identifies the cluster to create Search Nodes for.`, + Description: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -1458,44 +1458,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getAtlasSearchDeployment`, - Version: shared_api.NewStableVersion(2024, 5, 30), - Params: map[string]string{ - `clusterName`: `input:clusterName`, - `groupId`: `input:groupId`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.stateName`, - Values: []string{ - `IDLE`, - }, - }, - }, }, }, { - OperationID: `createAtlasSearchIndex`, - ShortOperationID: ``, + OperationID: `createGroupClusterSearchDeployment`, + ShortOperationID: `createClusterSearchDeployment`, Aliases: nil, - Description: `Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + Description: `Creates Search Nodes for the specified cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclustersearchdeployment. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchIndex/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createGroupClusterSearchDeployment/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -1535,7 +1510,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, + Description: `Label that identifies the cluster to create Search Nodes for.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -1547,6 +1522,13 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, { Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: `json`, @@ -1555,18 +1537,36 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `updateGroupClusterSearchDeployment`, + Version: shared_api.NewStableVersion(2024, 5, 30), + Params: map[string]string{ + `clusterName`: `input:clusterName`, + `groupId`: `input:groupId`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.stateName`, + Values: []string{ + `IDLE`, + }, + }, + }, + }, }, { - OperationID: `createAtlasSearchIndexDeprecated`, - ShortOperationID: ``, + OperationID: `createGroupClusterSearchIndex`, + ShortOperationID: `createClusterSearchIndex`, Aliases: nil, Description: `Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlassearchindexdeprecated. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclustersearchindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createGroupClusterSearchIndex/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -1619,7 +1619,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -1628,14 +1628,95 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAtlasSearchDeployment`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterFtsIndex`, + ShortOperationID: `deleteClusterFtsIndex`, + Aliases: nil, + Description: `Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterftsindex. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteGroupClusterFtsIndex/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}`, + 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: `clusterName`, + Description: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `indexId`, + Description: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodDelete, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `deleteGroupClusterSearchDeployment`, + ShortOperationID: `deleteClusterSearchDeployment`, Aliases: nil, Description: `Deletes the Search Nodes for the specified cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchdeployment. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersearchdeployment. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteGroupClusterSearchDeployment/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment`, QueryParameters: []shared_api.Parameter{ @@ -1706,7 +1787,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getAtlasSearchDeployment`, + OperationID: `deleteGroupClusterSearchDeployment`, Version: shared_api.NewStableVersion(2024, 5, 30), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -1720,14 +1801,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAtlasSearchIndex`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterSearchIndex`, + ShortOperationID: `deleteClusterSearchIndex`, Aliases: nil, Description: `Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersearchindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndex/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteGroupClusterSearchIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}`, QueryParameters: []shared_api.Parameter{ @@ -1801,14 +1882,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAtlasSearchIndexByName`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterSearchIndexByName`, + ShortOperationID: `deleteIndexByName`, Aliases: nil, Description: `Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexbyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersearchindexbyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteGroupClusterSearchIndexByName/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}`, QueryParameters: []shared_api.Parameter{ @@ -1902,14 +1983,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAtlasSearchIndexDeprecated`, - ShortOperationID: ``, + OperationID: `getGroupClusterFtsIndex`, + ShortOperationID: `getClusterFtsIndex`, Aliases: nil, - Description: `Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + Description: `Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteatlassearchindexdeprecated. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterftsindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getGroupClusterFtsIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}`, QueryParameters: []shared_api.Parameter{ @@ -1951,7 +2032,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, + Description: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -1961,7 +2042,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `indexId`, - Description: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.`, + Description: `Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -1970,7 +2051,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -1983,14 +2064,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAtlasSearchDeployment`, - ShortOperationID: ``, + OperationID: `getGroupClusterSearchDeployment`, + ShortOperationID: `getClusterSearchDeployment`, Aliases: nil, Description: `Returns the Search Nodes for the specified cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchdeployment. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersearchdeployment. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchDeployment/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getGroupClusterSearchDeployment/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment`, QueryParameters: []shared_api.Parameter{ @@ -2068,14 +2149,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAtlasSearchIndex`, - ShortOperationID: ``, + OperationID: `getGroupClusterSearchIndex`, + ShortOperationID: `getClusterSearchIndex`, Aliases: nil, Description: `Returns one Atlas Search index that you identified with its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersearchindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndex/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getGroupClusterSearchIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}`, QueryParameters: []shared_api.Parameter{ @@ -2149,14 +2230,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAtlasSearchIndexByName`, - ShortOperationID: ``, + OperationID: `getGroupClusterSearchIndexByName`, + ShortOperationID: `getIndexByName`, Aliases: nil, Description: `Returns one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexbyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersearchindexbyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndexByName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getGroupClusterSearchIndexByName/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}`, QueryParameters: []shared_api.Parameter{ @@ -2250,16 +2331,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAtlasSearchIndexDeprecated`, - ShortOperationID: ``, + OperationID: `listGroupClusterFtsIndex`, + ShortOperationID: `listClusterFtsIndex`, Aliases: nil, - Description: `Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + Description: `Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlassearchindexdeprecated. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterftsindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listGroupClusterFtsIndex/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -2308,8 +2389,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `indexId`, - Description: `Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes.`, + Name: `collectionName`, + Description: `Name of the collection that contains one or more Atlas Search indexes.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `databaseName`, + Description: `Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -2331,14 +2422,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAtlasSearchIndexes`, - ShortOperationID: ``, + OperationID: `listGroupClusterSearchIndex`, + ShortOperationID: `listSearchIndex`, Aliases: nil, Description: `Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersearchindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexes/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listGroupClusterSearchIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}`, QueryParameters: []shared_api.Parameter{ @@ -2422,14 +2513,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAtlasSearchIndexesCluster`, - ShortOperationID: ``, + OperationID: `listGroupClusterSearchIndexes`, + ShortOperationID: `listClusterSearchIndexes`, Aliases: nil, Description: `Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexescluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersearchindexes. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listGroupClusterSearchIndexes/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes`, QueryParameters: []shared_api.Parameter{ @@ -2493,16 +2584,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAtlasSearchIndexesDeprecated`, - ShortOperationID: ``, + OperationID: `updateGroupClusterFtsIndex`, + ShortOperationID: `updateClusterFtsIndex`, Aliases: nil, - Description: `Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. + Description: `Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlassearchindexesdeprecated. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterftsindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateGroupClusterFtsIndex/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -2542,17 +2633,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `collectionName`, - Description: `Name of the collection that contains one or more Atlas Search indexes.`, + Description: `Name of the cluster that contains the collection whose Atlas Search index to update.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -2561,8 +2642,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `databaseName`, - Description: `Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + Name: `indexId`, + Description: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -2571,12 +2652,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -2584,14 +2665,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateAtlasSearchDeployment`, - ShortOperationID: ``, + OperationID: `updateGroupClusterSearchDeployment`, + ShortOperationID: `updateClusterSearchDeployment`, Aliases: nil, Description: `Updates the Search Nodes for the specified cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchdeployment. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersearchdeployment. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchDeployment/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateGroupClusterSearchDeployment/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment`, QueryParameters: []shared_api.Parameter{ @@ -2662,7 +2743,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getAtlasSearchDeployment`, + OperationID: `updateGroupClusterSearchDeployment`, Version: shared_api.NewStableVersion(2024, 5, 30), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -2680,14 +2761,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateAtlasSearchIndex`, - ShortOperationID: ``, + OperationID: `updateGroupClusterSearchIndex`, + ShortOperationID: `updateClusterSearchIndex`, Aliases: nil, Description: `Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersearchindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndex/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateGroupClusterSearchIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}`, QueryParameters: []shared_api.Parameter{ @@ -2761,14 +2842,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateAtlasSearchIndexByName`, - ShortOperationID: ``, + OperationID: `updateGroupClusterSearchIndexByName`, + ShortOperationID: `updateIndexByName`, Aliases: nil, Description: `Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexbyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersearchindexbyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateGroupClusterSearchIndexByName/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}`, QueryParameters: []shared_api.Parameter{ @@ -2861,17 +2942,23 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + }, + }, + { + Name: `Auditing`, + Description: `Returns and edits database auditing settings for MongoDB Cloud projects.`, + Commands: []shared_api.Command{ { - OperationID: `updateAtlasSearchIndexDeprecated`, + OperationID: `getGroupAuditLog`, ShortOperationID: ``, Aliases: nil, - Description: `Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. + Description: `Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateatlassearchindexdeprecated. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupauditlog. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-getGroupAuditLog/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}`, + URL: `/api/atlas/v2/groups/{groupId}/auditLog`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -2909,54 +2996,28 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `clusterName`, - Description: `Name of the cluster that contains the collection whose Atlas Search index to update.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `indexId`, - Description: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPatch, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, }, - }, - }, - { - Name: `Auditing`, - Description: `Returns and edits database auditing settings for MongoDB Cloud projects.`, - Commands: []shared_api.Command{ { - OperationID: `getAuditingConfiguration`, - ShortOperationID: ``, + OperationID: `updateGroupAuditLog`, + ShortOperationID: `updateAuditLog`, Aliases: nil, - Description: `Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. + Description: `Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getauditingconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupauditlog. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-getAuditingConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-updateGroupAuditLog/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/auditLog`, QueryParameters: []shared_api.Parameter{ @@ -2997,29 +3058,35 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Cloud Backups`, + Description: `Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.`, + Commands: []shared_api.Command{ { - OperationID: `updateAuditingConfiguration`, - ShortOperationID: ``, + OperationID: `cancelGroupClusterBackupRestoreJob`, + ShortOperationID: `cancelBackupRestoreJob`, Aliases: nil, - Description: `Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. + Description: `Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateauditingconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cancelgroupclusterbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-updateAuditingConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-cancelGroupClusterBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/auditLog`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3057,36 +3124,50 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, 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: `restoreJobId`, + Description: `Unique 24-hexadecimal digit string that identifies the restore job to remove.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPatch, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, }, - }, - }, - { - Name: `Cloud Backups`, - Description: `Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.`, - Commands: []shared_api.Command{ { - OperationID: `cancelBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupBackupExportBucket`, + ShortOperationID: `createExportBucket`, Aliases: nil, - Description: `Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + Description: `Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cancelbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupbackupexportbucket. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-cancelBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createGroupBackupExportBucket/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}`, + URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3124,33 +3205,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, 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: `restoreJobId`, - Description: `Unique 24-hexadecimal digit string that identifies the restore job to remove.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodDelete, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2024, 5, 30), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -3158,14 +3226,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createBackupExportJob`, - ShortOperationID: ``, + OperationID: `createGroupClusterBackupExport`, + ShortOperationID: `createBackupExport`, Aliases: nil, Description: `Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createbackupexportjob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackupexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createBackupExportJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createGroupClusterBackupExport/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports`, QueryParameters: []shared_api.Parameter{ @@ -3219,11 +3287,10 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getBackupExportJob`, + OperationID: `createGroupClusterBackupExport`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `clusterName`: `input:clusterName`, - `exportId`: `body:$.id`, `groupId`: `input:groupId`, }, }, @@ -3240,17 +3307,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupClusterBackupRestoreJob`, + ShortOperationID: `createBackupRestoreJob`, Aliases: nil, Description: `Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createGroupClusterBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -3314,85 +3381,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createExportBucket`, - ShortOperationID: ``, - Aliases: nil, - Description: `Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createexportbucket. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createExportBucket/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets`, - 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`}, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `createServerlessBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupServerlessBackupRestoreJob`, + ShortOperationID: `createServerlessRestoreJob`, Aliases: nil, Description: `Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserverlessbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-createGroupServerlessBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -3456,16 +3455,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAllBackupSchedules`, - ShortOperationID: ``, + OperationID: `deleteGroupBackupExportBucket`, + ShortOperationID: `deleteExportBucket`, Aliases: nil, - Description: `Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + Description: `Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallbackupschedules. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupbackupexportbucket. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteAllBackupSchedules/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteGroupBackupExportBucket/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, + URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3494,8 +3493,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Name: `exportBucketId`, + Description: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -3514,26 +3513,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `deleteExportBucket`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterBackupSchedule`, + ShortOperationID: `deleteClusterBackupSchedule`, Aliases: nil, - Description: `Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + Description: `Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteexportbucket. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupschedule. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteExportBucket/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteGroupClusterBackupSchedule/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3562,8 +3554,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `exportBucketId`, - Description: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -3582,17 +3574,24 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, + { + Version: shared_api.NewStableVersion(2024, 8, 5), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, }, }, { - OperationID: `deleteReplicaSetBackup`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterBackupSnapshot`, + ShortOperationID: `deleteClusterBackupSnapshot`, Aliases: nil, Description: `Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletereplicasetbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteReplicaSetBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteGroupClusterBackupSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -3666,7 +3665,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getReplicaSetBackup`, + OperationID: `deleteGroupClusterBackupSnapshot`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -3681,14 +3680,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteShardedClusterBackup`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterBackupSnapshotShardedCluster`, + ShortOperationID: `deleteBackupShardedCluster`, Aliases: nil, Description: `Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteshardedclusterbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterbackupsnapshotshardedcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteShardedClusterBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-deleteGroupClusterBackupSnapshotShardedCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -3762,14 +3761,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `disableDataProtectionSettings`, - ShortOperationID: ``, + OperationID: `disableGroupBackupCompliancePolicy`, + ShortOperationID: `disableCompliancePolicy`, Aliases: nil, Description: `Disables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disabledataprotectionsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupbackupcompliancepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-disableDataProtectionSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-disableGroupBackupCompliancePolicy/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/backupCompliancePolicy`, QueryParameters: []shared_api.Parameter{ @@ -3823,7 +3822,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getDataProtectionSettings`, + OperationID: `updateGroupBackupCompliancePolicy`, Version: shared_api.NewStableVersion(2023, 10, 1), Params: map[string]string{ `groupId`: `input:groupId`, @@ -3840,16 +3839,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getBackupExportJob`, - ShortOperationID: ``, + OperationID: `getGroupBackupCompliancePolicy`, + ShortOperationID: `getCompliancePolicy`, Aliases: nil, - Description: `Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. + Description: `Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupexportjob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbackupcompliancepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupExportJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupBackupCompliancePolicy/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}`, + URL: `/api/atlas/v2/groups/{groupId}/backupCompliancePolicy`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3861,6 +3860,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -3877,19 +3886,67 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2023, 10, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getGroupBackupExportBucket`, + ShortOperationID: `getExportBucket`, + Aliases: nil, + Description: `Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbackupexportbucket. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupBackupExportBucket/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}`, + QueryParameters: []shared_api.Parameter{ { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + 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: true, + 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: `exportId`, - Description: `Unique 24-hexadecimal character string that identifies the Export Job.`, + Name: `exportBucketId`, + Description: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -3908,19 +3965,26 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, + { + Version: shared_api.NewStableVersion(2024, 5, 30), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, }, }, { - OperationID: `getBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupExport`, + ShortOperationID: `getBackupExport`, Aliases: nil, - Description: `Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + Description: `Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupClusterBackupExport/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -3932,16 +3996,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -3960,7 +4014,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster with the restore jobs you want to return.`, + Description: `Human-readable label that identifies the cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -3969,8 +4023,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `restoreJobId`, - Description: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + Name: `exportId`, + Description: `Unique 24-hexadecimal character string that identifies the Export Job.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -3992,16 +4046,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getBackupSchedule`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupRestoreJob`, + ShortOperationID: `getBackupRestoreJob`, Aliases: nil, - Description: `Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getbackupschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupSchedule/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupClusterBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4041,7 +4095,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Description: `Human-readable label that identifies the cluster with the restore jobs you want to return.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `restoreJobId`, + Description: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -4060,26 +4124,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `getDataProtectionSettings`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupSchedule`, + ShortOperationID: `getBackupSchedule`, Aliases: nil, - Description: `Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting 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-getdataprotectionsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupschedule. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getDataProtectionSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupClusterBackupSchedule/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backupCompliancePolicy`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4117,6 +4174,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, 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, }, @@ -4129,7 +4196,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Version: shared_api.NewStableVersion(2023, 10, 1), + Version: shared_api.NewStableVersion(2024, 8, 5), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -4138,16 +4205,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getExportBucket`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupSnapshot`, + ShortOperationID: `getClusterBackupSnapshot`, Aliases: nil, - Description: `Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getexportbucket. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getExportBucket/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupClusterBackupSnapshot/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4159,6 +4226,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -4176,8 +4253,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `exportBucketId`, - Description: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `snapshotId`, + Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -4196,26 +4283,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `getReplicaSetBackup`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupSnapshotShardedCluster`, + ShortOperationID: `getBackupShardedCluster`, Aliases: nil, - Description: `Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + Description: `Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getreplicasetbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupsnapshotshardedcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getReplicaSetBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupClusterBackupSnapshotShardedCluster/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4287,19 +4367,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServerlessBackup`, - ShortOperationID: ``, + OperationID: `getGroupServerlessBackupRestoreJob`, + ShortOperationID: `getServerlessRestoreJob`, Aliases: nil, - Description: `Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns one restore job for one serverless instance from the specified project. 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 with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getServerlessBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupServerlessBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}`, + URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4311,6 +4391,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -4338,8 +4428,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `snapshotId`, - Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + Name: `restoreJobId`, + Description: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -4361,19 +4451,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServerlessBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `getGroupServerlessBackupSnapshot`, + ShortOperationID: `getServerlessBackupSnapshot`, Aliases: nil, - Description: `Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. +This endpoint can also be used on Flex clusters that were created with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessbackupsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getGroupServerlessBackupSnapshot/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}`, + URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4385,16 +4475,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -4422,8 +4502,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `restoreJobId`, - Description: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + Name: `snapshotId`, + Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -4445,16 +4525,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getShardedClusterBackup`, - ShortOperationID: ``, + OperationID: `listGroupBackupExportBuckets`, + ShortOperationID: `listExportBuckets`, Aliases: nil, - Description: `Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + Description: `Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getshardedclusterbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupbackupexportbuckets. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getShardedClusterBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupBackupExportBuckets/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}`, + URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4467,8 +4547,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -4476,41 +4556,51 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `int`, }, - Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, Short: ``, - Required: true, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `int`, }, }, { - Name: `snapshotId`, - Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, - Required: true, + 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`}, }, }, Verb: http.MethodGet, @@ -4523,17 +4613,24 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, + { + Version: shared_api.NewStableVersion(2024, 5, 30), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, }, }, { - OperationID: `listBackupExportJobs`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupExports`, + ShortOperationID: `listBackupExports`, Aliases: nil, Description: `Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackupexportjobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupexports. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listBackupExportJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupClusterBackupExports/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports`, QueryParameters: []shared_api.Parameter{ @@ -4627,14 +4724,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listBackupRestoreJobs`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupRestoreJobs`, + ShortOperationID: `listBackupRestoreJobs`, Aliases: nil, Description: `Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listbackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuprestorejobs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listBackupRestoreJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupClusterBackupRestoreJobs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -4728,16 +4825,87 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listExportBuckets`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupSnapshotShardedClusters`, + ShortOperationID: `listBackupShardedClusters`, Aliases: nil, - Description: `Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listexportbuckets. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupsnapshotshardedclusters. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listExportBuckets/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupClusterBackupSnapshotShardedClusters/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backup/exportBuckets`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters`, + 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: `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(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `listGroupClusterBackupSnapshots`, + ShortOperationID: `listBackupSnapshots`, + Aliases: nil, + Description: `Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupsnapshots. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupClusterBackupSnapshots/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4805,6 +4973,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, 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, }, @@ -4816,26 +4994,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `listReplicaSetBackups`, - ShortOperationID: ``, + OperationID: `listGroupServerlessBackupRestoreJobs`, + ShortOperationID: `listServerlessRestoreJobs`, Aliases: nil, - Description: `Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + Description: `Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listreplicasetbackups. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessbackuprestorejobs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listReplicaSetBackups/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupServerlessBackupRestoreJobs/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots`, + URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4905,7 +5079,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Description: `Human-readable label that identifies the serverless instance.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -4927,19 +5101,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listServerlessBackupRestoreJobs`, - ShortOperationID: ``, + OperationID: `listGroupServerlessBackupSnapshots`, + ShortOperationID: `listServerlessBackupSnapshots`, Aliases: nil, - Description: `Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. +This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessbackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessbackupsnapshots. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listGroupServerlessBackupSnapshots/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs`, + URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -4952,8 +5126,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -4962,18 +5136,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `int`, + Type: `bool`, }, }, { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -4982,13 +5156,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, }, }, }, @@ -5031,19 +5205,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listServerlessBackups`, - ShortOperationID: ``, + OperationID: `takeGroupClusterBackupSnapshots`, + ShortOperationID: `takeSnapshots`, Aliases: nil, - Description: `Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. -This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessbackups. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-takegroupclusterbackupsnapshots. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listServerlessBackups/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-takeGroupClusterBackupSnapshots/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5065,36 +5239,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -5113,7 +5257,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the serverless instance.`, + Description: `Human-readable label that identifies the cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -5122,29 +5266,48 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `takeGroupClusterBackupSnapshots`, + Version: shared_api.NewStableVersion(2023, 1, 1), + Params: map[string]string{ + `clusterName`: `input:clusterName`, + `groupId`: `input:groupId`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.status`, + Values: []string{ + `completed`, + `failed`, + }, + }, + }, + }, }, { - OperationID: `listShardedClusterBackups`, - ShortOperationID: ``, + OperationID: `updateGroupBackupCompliancePolicy`, + ShortOperationID: `updateCompliancePolicy`, Aliases: nil, - Description: `Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. + Description: `Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listshardedclusterbackups. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupbackupcompliancepolicy. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listShardedClusterBackups/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateGroupBackupCompliancePolicy/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters`, + URL: `/api/atlas/v2/groups/{groupId}/backupCompliancePolicy`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5156,6 +5319,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `overwriteBackupPolicies`, + Description: `Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.`, + 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.`, @@ -5182,43 +5355,54 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, 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, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2023, 10, 1), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `updateGroupBackupCompliancePolicy`, + Version: shared_api.NewStableVersion(2023, 10, 1), + Params: map[string]string{ + `groupId`: `input:groupId`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.state`, + Values: []string{ + `ACTIVE`, + }, + }, + }, + }, }, { - OperationID: `takeSnapshot`, - ShortOperationID: ``, + OperationID: `updateGroupClusterBackupSchedule`, + ShortOperationID: `updateBackupSchedule`, Aliases: nil, - Description: `Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. - - -To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. + Description: `Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-takesnapshot. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterbackupschedule. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-takeSnapshot/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateGroupClusterBackupSchedule/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5267,7 +5451,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPost, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { @@ -5277,39 +5461,26 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getReplicaSetBackup`, - Version: shared_api.NewStableVersion(2023, 1, 1), - Params: map[string]string{ - `clusterName`: `input:clusterName`, - `groupId`: `input:groupId`, - `snapshotId`: `body:$.id`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.status`, - Values: []string{ - `completed`, - `failed`, - }, + { + Version: shared_api.NewStableVersion(2024, 8, 5), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, }, }, }, }, { - OperationID: `updateBackupSchedule`, - ShortOperationID: ``, + OperationID: `updateGroupClusterBackupSnapshot`, + ShortOperationID: `updateBackupSnapshot`, Aliases: nil, - Description: `Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. The requesting API Key must have the Project Backup Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatebackupschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterbackupsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateBackupSchedule/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateGroupClusterBackupSnapshot/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5357,6 +5528,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, + { + Name: `snapshotId`, + Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPatch, }, @@ -5368,26 +5549,54 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, + }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `updateGroupClusterBackupSnapshot`, + Version: shared_api.NewStableVersion(2023, 1, 1), + Params: map[string]string{ + `clusterName`: `input:clusterName`, + `groupId`: `input:groupId`, + `snapshotId`: `input:snapshotId`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.status`, + Values: []string{ + `completed`, + `failed`, + }, }, }, }, }, + }, + }, + { + Name: `Cloud Migration Service`, + Description: `Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.`, + Commands: []shared_api.Command{ { - OperationID: `updateDataProtectionSettings`, + OperationID: `createGroupLiveMigration`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. + + +Please make sure to validate your migration before initiating it. + + +You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedataprotectionsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateDataProtectionSettings/`, +NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategrouplivemigration. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-createGroupLiveMigration/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/backupCompliancePolicy`, + URL: `/api/atlas/v2/groups/{groupId}/liveMigrations`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5399,16 +5608,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `overwriteBackupPolicies`, - Description: `Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.`, - 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.`, @@ -5436,7 +5635,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, }, - Verb: http.MethodPut, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -5447,42 +5646,25 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Version: shared_api.NewStableVersion(2023, 10, 1), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getDataProtectionSettings`, - Version: shared_api.NewStableVersion(2023, 10, 1), - Params: map[string]string{ - `groupId`: `input:groupId`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.state`, - Values: []string{ - `ACTIVE`, - }, - }, - }, - }, }, { - OperationID: `updateSnapshotRetention`, - ShortOperationID: ``, + OperationID: `createOrgLiveMigrationLinkToken`, + ShortOperationID: `createLinkToken`, Aliases: nil, - Description: `Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. The requesting API Key must have the Project Backup Manager role. + Description: `Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatesnapshotretention. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorglivemigrationlinktoken. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-updateSnapshotRetention/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-createOrgLiveMigrationLinkToken/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}`, + URL: `/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5507,32 +5689,79 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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. + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `cutoverGroupLiveMigration`, + ShortOperationID: `cutoverMigration`, + Aliases: nil, + Description: `Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cutovergrouplivemigration. -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, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-cutoverGroupLiveMigration/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover`, + 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: `string`, + Type: `bool`, }, - Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, - Required: true, + 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: `snapshotId`, - Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + Name: `liveMigrationId`, + Description: `Unique 24-hexadecimal digit string that identifies the migration.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -5541,53 +5770,27 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getReplicaSetBackup`, - Version: shared_api.NewStableVersion(2023, 1, 1), - Params: map[string]string{ - `clusterName`: `input:clusterName`, - `groupId`: `input:groupId`, - `snapshotId`: `input:snapshotId`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.status`, - Values: []string{ - `completed`, - `failed`, - }, - }, - }, - }, }, - }, - }, - { - Name: `Cloud Migration Service`, - Description: `Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.`, - Commands: []shared_api.Command{ { - OperationID: `createLinkToken`, - ShortOperationID: ``, + OperationID: `deleteOrgLiveMigrationLinkTokens`, + ShortOperationID: `deleteLinkTokens`, Aliases: nil, - Description: `Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. + Description: `Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlinktoken. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorglivemigrationlinktokens. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-createLinkToken/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-deleteOrgLiveMigrationLinkTokens/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens`, QueryParameters: []shared_api.Parameter{ @@ -5601,16 +5804,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -5624,12 +5817,12 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -5637,25 +5830,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createPushMigration`, + OperationID: `getGroupLiveMigration`, ShortOperationID: ``, Aliases: nil, - Description: `Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. - - -Please make sure to validate your migration before initiating it. - - -You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. - - -NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. + Description: `Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpushmigration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplivemigration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-createPushMigration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-getGroupLiveMigration/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/liveMigrations`, + URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5693,20 +5877,23 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `liveMigrationId`, + Description: `Unique 24-hexadecimal digit string that identifies the migration.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPost, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -5714,16 +5901,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `cutoverMigration`, - ShortOperationID: ``, + OperationID: `getGroupLiveMigrationValidateStatus`, + ShortOperationID: `getMigrationValidateStatus`, Aliases: nil, - Description: `Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. + Description: `Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-cutovermigration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplivemigrationvalidatestatus. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-cutoverMigration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-getGroupLiveMigrationValidateStatus/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover`, + URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5735,16 +5922,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -5762,8 +5939,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `liveMigrationId`, - Description: `Unique 24-hexadecimal digit string that identifies the migration.`, + Name: `validationId`, + Description: `Unique 24-hexadecimal digit string that identifies the validation job.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -5772,7 +5949,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPut, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -5785,16 +5962,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteLinkToken`, - ShortOperationID: ``, + OperationID: `listOrgLiveMigrationAvailableProjects`, + ShortOperationID: `listAvailableProjects`, Aliases: nil, - Description: `Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. + Description: `Return all projects that you can migrate to the specified organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelinktoken. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorglivemigrationavailableprojects. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-deleteLinkToken/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-listOrgLiveMigrationAvailableProjects/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens`, + URL: `/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5806,6 +5983,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -5819,7 +6006,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -5832,16 +6019,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getPushMigration`, - ShortOperationID: ``, + OperationID: `validateGroupLiveMigrations`, + ShortOperationID: `validateLiveMigrations`, Aliases: nil, - Description: `Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. + Description: `Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpushmigration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validategrouplivemigrations. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-getPushMigration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-validateGroupLiveMigrations/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}`, + URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/validate`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5879,40 +6066,43 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `liveMigrationId`, - Description: `Unique 24-hexadecimal digit string that identifies the migration.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2024, 5, 30), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Cloud Provider Access`, + Description: `Returns, adds, authorizes, and removes AWS IAM roles in Atlas.`, + Commands: []shared_api.Command{ { - OperationID: `getValidationStatus`, - ShortOperationID: ``, + OperationID: `authorizeGroupCloudProviderAccessRole`, + ShortOperationID: `authorizeProviderAccessRole`, Aliases: nil, - Description: `Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. + Description: `Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getvalidationstatus. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-authorizegroupcloudprovideraccessrole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-getValidationStatus/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-authorizeGroupCloudProviderAccessRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}`, + URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5924,6 +6114,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -5941,8 +6141,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `validationId`, - Description: `Unique 24-hexadecimal digit string that identifies the validation job.`, + Name: `roleId`, + Description: `Unique 24-hexadecimal digit string that identifies the role.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -5951,12 +6151,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -5964,16 +6164,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listSourceProjects`, - ShortOperationID: ``, + OperationID: `createGroupCloudProviderAccess`, + ShortOperationID: `createCloudProviderAccess`, Aliases: nil, - Description: `Return all projects that you can migrate to the specified organization. + Description: `Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsourceprojects. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcloudprovideraccess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-listSourceProjects/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-createGroupCloudProviderAccess/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects`, + URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -5998,22 +6198,26 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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`}, }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -6021,222 +6225,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `validateMigration`, - ShortOperationID: ``, + OperationID: `deauthorizeGroupCloudProviderAccessRole`, + ShortOperationID: `deauthorizeProviderAccessRole`, Aliases: nil, - Description: `Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. + Description: `Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validatemigration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deauthorizegroupcloudprovideraccessrole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-validateMigration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-deauthorizeGroupCloudProviderAccessRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/liveMigrations/validate`, - 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`}, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - }, - }, - { - Name: `Cloud Provider Access`, - Description: `Returns, adds, authorizes, and removes AWS IAM roles in Atlas.`, - Commands: []shared_api.Command{ - { - OperationID: `authorizeCloudProviderAccessRole`, - ShortOperationID: ``, - Aliases: nil, - Description: `Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-authorizecloudprovideraccessrole. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}`, - 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: `roleId`, - Description: `Unique 24-hexadecimal digit string that identifies the role.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodPatch, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `createCloudProviderAccessRole`, - ShortOperationID: ``, - Aliases: nil, - Description: `Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcloudprovideraccessrole. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess`, - 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`}, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `deauthorizeCloudProviderAccessRole`, - ShortOperationID: ``, - Aliases: nil, - Description: `Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deauthorizecloudprovideraccessrole. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}`, + URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -6308,14 +6306,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCloudProviderAccessRole`, - ShortOperationID: ``, + OperationID: `getGroupCloudProviderAccess`, + ShortOperationID: `getCloudProviderAccess`, Aliases: nil, Description: `Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcloudprovideraccessrole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcloudprovideraccess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-getGroupCloudProviderAccess/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}`, QueryParameters: []shared_api.Parameter{ @@ -6379,14 +6377,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listCloudProviderAccessRoles`, - ShortOperationID: ``, + OperationID: `listGroupCloudProviderAccess`, + ShortOperationID: `listCloudProviderAccess`, Aliases: nil, Description: `Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudprovideraccessroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcloudprovideraccess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudProviderAccess-listGroupCloudProviderAccess/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/cloudProviderAccess`, QueryParameters: []shared_api.Parameter{ @@ -6446,14 +6444,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, starts, or ends a cluster outage simulation.`, Commands: []shared_api.Command{ { - OperationID: `endOutageSimulation`, - ShortOperationID: ``, + OperationID: `endGroupClusterOutageSimulation`, + ShortOperationID: `endOutageSimulation`, Aliases: nil, Description: `Ends a cluster outage simulation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-endoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-endgroupclusteroutagesimulation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-endOutageSimulation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-endGroupClusterOutageSimulation/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation`, QueryParameters: []shared_api.Parameter{ @@ -6517,7 +6515,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getOutageSimulation`, + OperationID: `endGroupClusterOutageSimulation`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -6531,14 +6529,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getOutageSimulation`, - ShortOperationID: ``, + OperationID: `getGroupClusterOutageSimulation`, + ShortOperationID: `getOutageSimulation`, Aliases: nil, Description: `Returns one outage simulation for one cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusteroutagesimulation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-getOutageSimulation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-getGroupClusterOutageSimulation/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation`, QueryParameters: []shared_api.Parameter{ @@ -6602,14 +6600,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `startOutageSimulation`, - ShortOperationID: ``, + OperationID: `startGroupClusterOutageSimulation`, + ShortOperationID: `startOutageSimulation`, Aliases: nil, Description: `Starts a cluster outage simulation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startoutagesimulation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupclusteroutagesimulation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-startOutageSimulation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusterOutageSimulation-startGroupClusterOutageSimulation/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation`, QueryParameters: []shared_api.Parameter{ @@ -6673,7 +6671,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getOutageSimulation`, + OperationID: `startGroupClusterOutageSimulation`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -6697,14 +6695,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`, Commands: []shared_api.Command{ { - OperationID: `autoScalingConfiguration`, - ShortOperationID: ``, + OperationID: `autoGroupClusterScalingConfiguration`, + ShortOperationID: `autoScalingConfiguration`, Aliases: nil, Description: `Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-autoscalingconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-autogroupclusterscalingconfiguration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-autoScalingConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-autoGroupClusterScalingConfiguration/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration`, QueryParameters: []shared_api.Parameter{ @@ -6768,17 +6766,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createCluster`, - ShortOperationID: ``, + OperationID: `createGroupCluster`, + ShortOperationID: `createCluster`, Aliases: nil, Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-createCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-createGroupCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters`, QueryParameters: []shared_api.Parameter{ @@ -6853,11 +6851,10 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getCluster`, + OperationID: `createGroupCluster`, Version: shared_api.NewStableVersion(2024, 8, 5), Params: map[string]string{ - `clusterName`: `body:$.name`, - `groupId`: `body:$.groupId`, + `groupId`: `body:$.groupId`, }, }, Expect: &shared_api.WatcherExpectProperties{ @@ -6871,17 +6868,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteCluster`, - ShortOperationID: ``, + OperationID: `deleteGroupCluster`, + ShortOperationID: `deleteCluster`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-deleteCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-deleteGroupCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}`, QueryParameters: []shared_api.Parameter{ @@ -6962,8 +6959,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getCluster`, - Version: shared_api.NewStableVersion(2024, 8, 5), + OperationID: `deleteGroupCluster`, + Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `clusterName`: `input:clusterName`, `groupId`: `input:groupId`, @@ -6976,17 +6973,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCluster`, - ShortOperationID: ``, + OperationID: `getGroupCluster`, + ShortOperationID: `getCluster`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getGroupCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}`, QueryParameters: []shared_api.Parameter{ @@ -7064,14 +7061,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getClusterAdvancedConfiguration`, - ShortOperationID: ``, + OperationID: `getGroupClusterProcessArgs`, + ShortOperationID: `getProcessArgs`, Aliases: nil, Description: `Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusteradvancedconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterprocessargs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getClusterAdvancedConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getGroupClusterProcessArgs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs`, QueryParameters: []shared_api.Parameter{ @@ -7142,14 +7139,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getClusterStatus`, - ShortOperationID: ``, + OperationID: `getGroupClusterStatus`, + ShortOperationID: `getClusterStatus`, Aliases: nil, Description: `Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getclusterstatus. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterstatus. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getClusterStatus/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getGroupClusterStatus/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status`, QueryParameters: []shared_api.Parameter{ @@ -7213,14 +7210,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getSampleDatasetLoadStatus`, - ShortOperationID: ``, + OperationID: `getGroupSampleDatasetLoad`, + ShortOperationID: `getSampleDatasetLoad`, Aliases: nil, Description: `Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsampledatasetloadstatus. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupsampledatasetload. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getSampleDatasetLoadStatus/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getGroupSampleDatasetLoad/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}`, QueryParameters: []shared_api.Parameter{ @@ -7274,14 +7271,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `grantMongoDbEmployeeAccess`, - ShortOperationID: ``, + OperationID: `grantGroupClusterMongoDbEmployeeAccess`, + ShortOperationID: `grantMongoEmployeeAccess`, Aliases: nil, Description: `Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-grantmongodbemployeeaccess. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-grantgroupclustermongodbemployeeaccess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-grantMongoDbEmployeeAccess/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-grantGroupClusterMongoDbEmployeeAccess/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess`, QueryParameters: []shared_api.Parameter{ @@ -7345,16 +7342,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listCloudProviderRegions`, + OperationID: `listClusterDetails`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcloudproviderregions. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusterdetails. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listCloudProviderRegions/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listClusterDetails/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/provider/regions`, + URL: `/api/atlas/v2/clusters`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7406,44 +7403,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `providers`, - Description: `Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: true, - Type: `string`, - }, - }, - { - Name: `tier`, - Description: `Cluster tier for which to retrieve the regions.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - 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`}, - }, }, - Verb: http.MethodGet, + URLParameters: []shared_api.Parameter{}, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -7456,19 +7418,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listClusters`, - ShortOperationID: ``, + OperationID: `listGroupClusterProviderRegions`, + ShortOperationID: `listClusterProviderRegions`, Aliases: nil, - 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 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. + Description: `Returns the list of regions available for the specified cloud provider at the specified tier. 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-listclusters. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterproviderregions. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listClusters/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listGroupClusterProviderRegions/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/provider/regions`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7521,13 +7480,23 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `includeDeletedWithRetainedBackups`, - Description: `Flag that indicates whether to return Clusters with retain backups.`, + Name: `providers`, + Description: `Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `tier`, + Description: `Cluster tier for which to retrieve the regions.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `string`, }, }, }, @@ -7557,33 +7526,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you `json`, }, }, - { - Version: shared_api.NewStableVersion(2023, 2, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `listClustersForAllProjects`, - ShortOperationID: ``, + OperationID: `listGroupClusters`, + ShortOperationID: `listClusters`, Aliases: nil, - Description: `Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. + 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersforallprojects. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listClustersForAllProjects/`, +This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusters. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listGroupClusters/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/clusters`, + URL: `/api/atlas/v2/groups/{groupId}/clusters`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7635,9 +7593,34 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `includeDeletedWithRetainedBackups`, + Description: `Flag that indicates whether to return Clusters with retain backups.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, }, - URLParameters: []shared_api.Parameter{}, - Verb: http.MethodGet, + 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`}, + }, + }, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -7647,19 +7630,33 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c `json`, }, }, + { + Version: shared_api.NewStableVersion(2023, 2, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2024, 8, 5), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, }, }, { - OperationID: `loadSampleDataset`, - ShortOperationID: ``, + OperationID: `pinGroupClusterFeatureCompatibilityVersion`, + ShortOperationID: `pinFeatureCompatibilityVersion`, Aliases: nil, - Description: `Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-loadsampledataset. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pingroupclusterfeaturecompatibilityversion. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-loadSampleDataset/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-pinGroupClusterFeatureCompatibilityVersion/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7671,6 +7668,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -7688,8 +7695,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `name`, - Description: `Human-readable label that identifies the cluster into which you load the sample dataset.`, + Name: `clusterName`, + Description: `Human-readable label that identifies this cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -7702,44 +7709,25 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + Version: shared_api.NewStableVersion(2024, 5, 30), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getSampleDatasetLoadStatus`, - Version: shared_api.NewStableVersion(2023, 1, 1), - Params: map[string]string{ - `groupId`: `input:groupId`, - `sampleDatasetId`: `body:$.id`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.state`, - Values: []string{ - `COMPLETED`, - `FAILED`, - }, - }, - }, - }, }, { - OperationID: `pinFeatureCompatibilityVersion`, - ShortOperationID: ``, + OperationID: `requestGroupSampleDatasetLoad`, + ShortOperationID: `requestSampleDatasetLoad`, Aliases: nil, - Description: `Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. + Description: `Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinfeaturecompatibilityversion. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-requestgroupsampledatasetload. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-pinFeatureCompatibilityVersion/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-requestGroupSampleDatasetLoad/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion`, + URL: `/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7751,16 +7739,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -7778,8 +7756,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies this cluster.`, + Name: `name`, + Description: `Human-readable label that identifies the cluster into which you load the sample dataset.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -7792,25 +7770,44 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `requestGroupSampleDatasetLoad`, + Version: shared_api.NewStableVersion(2023, 1, 1), + Params: map[string]string{ + `groupId`: `input:groupId`, + `name`: `input:name`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.state`, + Values: []string{ + `COMPLETED`, + `FAILED`, + }, + }, + }, + }, }, { - OperationID: `revokeMongoDbEmployeeAccess`, - ShortOperationID: ``, + OperationID: `restartGroupClusterPrimaries`, + ShortOperationID: `restartPrimaries`, Aliases: nil, - Description: `Revokes a previously granted MongoDB employee cluster access. + 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. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokemongodbemployeeaccess. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-restartgroupclusterprimaries. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-revokeMongoDbEmployeeAccess/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-restartGroupClusterPrimaries/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7850,7 +7847,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies this cluster.`, + Description: `Human-readable label that identifies the cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -7863,7 +7860,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 8, 5), + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + { + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -7872,16 +7876,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `testFailover`, - ShortOperationID: ``, + OperationID: `revokeGroupClusterMongoDbEmployeeAccess`, + ShortOperationID: `revokeMongoEmployeeAccess`, Aliases: nil, - 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. + Description: `Revokes a previously granted MongoDB employee cluster access. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-testfailover. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokegroupclustermongodbemployeeaccess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-testFailover/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-revokeGroupClusterMongoDbEmployeeAccess/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -7921,7 +7925,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Description: `Human-readable label that identifies this cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -7934,14 +7938,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - { - Version: shared_api.NewStableVersion(2023, 2, 1), + Version: shared_api.NewStableVersion(2024, 8, 5), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -7950,14 +7947,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `unpinFeatureCompatibilityVersion`, - ShortOperationID: ``, + OperationID: `unpinGroupClusterFeatureCompatibilityVersion`, + ShortOperationID: `unpinFeatureCompatibilityVersion`, Aliases: nil, Description: `Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpinfeaturecompatibilityversion. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpingroupclusterfeaturecompatibilityversion. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-unpinFeatureCompatibilityVersion/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-unpinGroupClusterFeatureCompatibilityVersion/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion`, QueryParameters: []shared_api.Parameter{ @@ -8021,14 +8018,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateCluster`, - ShortOperationID: ``, + OperationID: `updateGroupCluster`, + ShortOperationID: `updateCluster`, Aliases: nil, Description: `Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-updateCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-updateGroupCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}`, QueryParameters: []shared_api.Parameter{ @@ -8113,7 +8110,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getCluster`, + OperationID: `updateGroupCluster`, Version: shared_api.NewStableVersion(2024, 8, 5), Params: map[string]string{ `clusterName`: `input:clusterName`, @@ -8131,14 +8128,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateClusterAdvancedConfiguration`, - ShortOperationID: ``, + OperationID: `updateGroupClusterProcessArgs`, + ShortOperationID: `updateProcessArgs`, Aliases: nil, Description: `Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateclusteradvancedconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusterprocessargs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-updateClusterAdvancedConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-updateGroupClusterProcessArgs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs`, QueryParameters: []shared_api.Parameter{ @@ -8209,17 +8206,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `upgradeSharedCluster`, - ShortOperationID: ``, + OperationID: `upgradeGroupClusterTenantUpgrade`, + ShortOperationID: `upgradeTenantUpgrade`, Aliases: nil, 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. This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradesharedcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradegroupclustertenantupgrade. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-upgradeSharedCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-upgradeGroupClusterTenantUpgrade/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade`, QueryParameters: []shared_api.Parameter{ @@ -8279,16 +8276,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.`, Commands: []shared_api.Command{ { - OperationID: `getCollStatsLatencyNamespaceClusterMeasurements`, - ShortOperationID: ``, + OperationID: `getGroupClusterCollStatNamespaces`, + ShortOperationID: `getClusterNamespaces`, Aliases: nil, - Description: `Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. + Description: `Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespaceclustermeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustercollstatnamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getGroupClusterCollStatNamespaces/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8300,16 +8297,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `metrics`, - Description: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: true, - Type: `string`, - }, - }, { Name: `start`, Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, @@ -8358,7 +8345,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster to retrieve metrics for.`, + Description: `Human-readable label that identifies the cluster to pin namespaces to.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8376,19 +8363,90 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 11, 15), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getGroupProcessCollStatNamespaces`, + ShortOperationID: `getProcessNamespaces`, + Aliases: nil, + Description: `Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocesscollstatnamespaces. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getGroupProcessCollStatNamespaces/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces`, + QueryParameters: []shared_api.Parameter{ { - Name: `databaseName`, - Description: `Human-readable label that identifies the database.`, + 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: true, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `start`, + Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, }, { - Name: `collectionName`, - Description: `Human-readable label that identifies the collection.`, + Name: `end`, + Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `period`, + Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + 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: `processId`, + Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8410,16 +8468,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCollStatsLatencyNamespaceHostMeasurements`, - ShortOperationID: ``, + OperationID: `listGroupClusterCollStatMeasurements`, + ShortOperationID: `listCollStatMeasurements`, Aliases: nil, - Description: `Get a list of the Coll Stats Latency process-level measurements for the given namespace. + Description: `Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacehostmeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustercollstatmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-listGroupClusterCollStatMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8488,8 +8546,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `processId`, - Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster to retrieve metrics for.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `clusterView`, + Description: `Human-readable label that identifies the cluster topology to retrieve metrics for.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8531,14 +8599,75 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCollStatsLatencyNamespaceMetrics`, - ShortOperationID: ``, + OperationID: `listGroupClusterCollStatPinnedNamespaces`, + ShortOperationID: `listPinnedNamespaces`, + Aliases: nil, + Description: `Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustercollstatpinnednamespaces. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-listGroupClusterCollStatPinnedNamespaces/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned`, + 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`, + }, + }, + }, + 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 to retrieve pinned namespaces for.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 11, 15), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `listGroupCollStatMetrics`, + ShortOperationID: `listCollStatMetrics`, Aliases: nil, Description: `Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacemetrics. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcollstatmetrics. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-listGroupCollStatMetrics/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/collStats/metrics`, QueryParameters: []shared_api.Parameter{ @@ -8582,16 +8711,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCollStatsLatencyNamespacesForCluster`, - ShortOperationID: ``, + OperationID: `listGroupProcessCollStatMeasurements`, + ShortOperationID: `listProcessMeasurements`, Aliases: nil, - Description: `Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. + Description: `Get a list of the Coll Stats Latency process-level measurements for the given namespace. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocesscollstatmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-listGroupProcessCollStatMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces`, + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8603,6 +8732,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `metrics`, + Description: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, { Name: `start`, Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, @@ -8650,8 +8789,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster to pin namespaces to.`, + Name: `processId`, + Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8660,8 +8799,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `clusterView`, - Description: `Human-readable label that identifies the cluster topology to retrieve metrics for.`, + Name: `databaseName`, + Description: `Human-readable label that identifies the database.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `collectionName`, + Description: `Human-readable label that identifies the collection.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8683,16 +8832,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCollStatsLatencyNamespacesForHost`, - ShortOperationID: ``, + OperationID: `pinGroupClusterCollStatPinnedNamespaces`, + ShortOperationID: `pinNamespaces`, Aliases: nil, - Description: `Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + Description: `Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcollstatslatencynamespacesforhost. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pingroupclustercollstatpinnednamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-pinGroupClusterCollStatPinnedNamespaces/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8704,36 +8853,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `start`, - Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `end`, - Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `period`, - Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -8751,8 +8870,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `processId`, - Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster to pin namespaces to.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8761,29 +8880,30 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 11, 15), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, + `json`, }, }, }, }, { - OperationID: `getPinnedNamespaces`, - ShortOperationID: ``, + OperationID: `unpinGroupClusterCollStatUnpinNamespaces`, + ShortOperationID: `unpinNamespaces`, Aliases: nil, - Description: `Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + Description: `Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpinnednamespaces. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpingroupclustercollstatunpinnamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-unpinGroupClusterCollStatUnpinNamespaces/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8813,7 +8933,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `clusterName`, - Description: `Human-readable label that identifies the cluster to retrieve pinned namespaces for.`, + Description: `Human-readable label that identifies the cluster to unpin namespaces from.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -8822,12 +8942,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 11, 15), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -8835,14 +8955,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `pinNamespacesPatch`, - ShortOperationID: ``, + OperationID: `updateGroupClusterCollStatPinnedNamespaces`, + ShortOperationID: `updatePinnedNamespaces`, Aliases: nil, Description: `Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacespatch. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustercollstatpinnednamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-updateGroupClusterCollStatPinnedNamespaces/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned`, QueryParameters: []shared_api.Parameter{ @@ -8896,17 +9016,23 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + }, + }, + { + Name: `Custom Database Roles`, + Description: `Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.`, + Commands: []shared_api.Command{ { - OperationID: `pinNamespacesPut`, - ShortOperationID: ``, + OperationID: `createGroupCustomDbRoleRole`, + ShortOperationID: `createCustomDbRole`, Aliases: nil, - Description: `Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. + Description: `Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-pinnamespacesput. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcustomdbrolerole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-pinNamespacesPut/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-createGroupCustomDbRoleRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned`, + URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8918,6 +9044,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -8934,41 +9070,30 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster to pin namespaces to.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPut, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 11, 15), + Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, - `json`, }, }, }, }, { - OperationID: `unpinNamespaces`, - ShortOperationID: ``, + OperationID: `deleteGroupCustomDbRoleRole`, + ShortOperationID: `deleteCustomDbRole`, Aliases: nil, - Description: `Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + Description: `Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-unpinnamespaces. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcustomdbrolerole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-unpinNamespaces/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-deleteGroupCustomDbRoleRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin`, + URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -8980,6 +9105,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -8997,8 +9132,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster to unpin namespaces from.`, + Name: `roleName`, + Description: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -9007,35 +9142,29 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 11, 15), - RequestContentType: `json`, + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, }, - }, - }, - { - Name: `Custom Database Roles`, - Description: `Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.`, - Commands: []shared_api.Command{ { - OperationID: `createCustomDatabaseRole`, - ShortOperationID: ``, + OperationID: `getGroupCustomDbRoleRole`, + ShortOperationID: `getCustomDbRole`, Aliases: nil, - Description: `Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. + Description: `Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomdatabaserole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcustomdbrolerole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-getGroupCustomDbRoleRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles`, + URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9073,13 +9202,23 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `roleName`, + Description: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPost, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -9087,16 +9226,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteCustomDatabaseRole`, - ShortOperationID: ``, + OperationID: `listGroupCustomDbRoleRoles`, + ShortOperationID: `listCustomDbRoles`, Aliases: nil, - Description: `Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. + Description: `Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecustomdatabaserole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcustomdbroleroles. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-listGroupCustomDbRoleRoles/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}`, + URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9134,18 +9273,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `roleName`, - Description: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -9158,14 +9287,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getCustomDatabaseRole`, - ShortOperationID: ``, + OperationID: `updateGroupCustomDbRoleRole`, + ShortOperationID: `updateCustomDbRole`, Aliases: nil, - Description: `Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcustomdatabaserole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcustomdbrolerole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-updateGroupCustomDbRoleRole/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}`, QueryParameters: []shared_api.Parameter{ @@ -9207,7 +9336,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `roleName`, - Description: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, + Description: `Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -9216,29 +9345,35 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Data Federation`, + Description: `Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.`, + Commands: []shared_api.Command{ { - OperationID: `listCustomDatabaseRoles`, - ShortOperationID: ``, + OperationID: `createGroupDataFederation`, + ShortOperationID: `createDataFederation`, Aliases: nil, - Description: `Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcustomdatabaseroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatafederation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-createGroupDataFederation/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles`, + URL: `/api/atlas/v2/groups/{groupId}/dataFederation`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9260,60 +9395,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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`}, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `updateCustomDatabaseRole`, - ShortOperationID: ``, - Aliases: nil, - Description: `Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecustomdatabaserole. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}`, - 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.`, + Name: `skipRoleValidation`, + Description: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -9337,18 +9421,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `roleName`, - Description: `Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPatch, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -9360,15 +9434,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - }, - }, - { - Name: `Data Federation`, - Description: `Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.`, - Commands: []shared_api.Command{ { - OperationID: `createDataFederationPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `createGroupPrivateNetworkSettingEndpointId`, + ShortOperationID: `createPrivateEndpointId`, Aliases: nil, Description: `Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -9399,9 +9467,9 @@ ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatafederationprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivatenetworksettingendpointid. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-createGroupPrivateNetworkSettingEndpointId/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds`, QueryParameters: []shared_api.Parameter{ @@ -9455,16 +9523,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createFederatedDatabase`, - ShortOperationID: ``, + OperationID: `deleteGroupDataFederation`, + ShortOperationID: `deleteDataFederation`, Aliases: nil, - Description: `Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. + Description: `Removes one federated database instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederateddatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatafederation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-createFederatedDatabase/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteGroupDataFederation/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation`, + URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9486,16 +9554,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `skipRoleValidation`, - Description: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -9512,13 +9570,23 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `tenantName`, + Description: `Human-readable label that identifies the federated database instance to remove.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -9526,14 +9594,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createOneDataFederationQueryLimit`, - ShortOperationID: ``, + OperationID: `deleteGroupDataFederationLimit`, + ShortOperationID: `deleteDataFederationLimit`, Aliases: nil, - Description: `Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Deletes one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonedatafederationquerylimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatafederationlimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-createOneDataFederationQueryLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteGroupDataFederationLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -9592,12 +9660,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -9605,14 +9673,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteDataFederationPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `deleteGroupPrivateNetworkSettingEndpointId`, + ShortOperationID: `deletePrivateEndpointId`, Aliases: nil, Description: `Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatafederationprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivatenetworksettingendpointid. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteGroupPrivateNetworkSettingEndpointId/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -9676,30 +9744,91 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteFederatedDatabase`, - ShortOperationID: ``, + OperationID: `downloadGroupDataFederationQueryLogs`, + ShortOperationID: `downloadFederationQueryLogs`, Aliases: nil, - Description: `Removes one federated database instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. + Description: `Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederateddatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupdatafederationquerylogs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteFederatedDatabase/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-downloadGroupDataFederationQueryLogs/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}`, + URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz`, 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.`, + Name: `endDate`, + Description: `Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `startDate`, + Description: `Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + }, + 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: `tenantName`, + Description: `Human-readable label that identifies the federated database instance for which you want to download query logs.`, + 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{ + `gzip`, + }, + }, + }, + }, + { + OperationID: `getGroupDataFederation`, + ShortOperationID: `getDataFederation`, + Aliases: nil, + Description: `Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatafederation. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-getGroupDataFederation/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}`, + 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{ @@ -9725,7 +9854,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the federated database instance to remove.`, + Description: `Human-readable label that identifies the Federated Database to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -9734,7 +9863,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -9747,14 +9876,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteOneDataFederationInstanceQueryLimit`, - ShortOperationID: ``, + OperationID: `getGroupDataFederationLimit`, + ShortOperationID: `getDataFederationLimit`, Aliases: nil, - Description: `Deletes one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonedatafederationinstancequerylimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatafederationlimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-getGroupDataFederationLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -9768,6 +9897,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -9813,7 +9952,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -9826,35 +9965,35 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `downloadFederatedDatabaseQueryLogs`, - ShortOperationID: ``, + OperationID: `getGroupPrivateNetworkSettingEndpointId`, + ShortOperationID: `getPrivateEndpointId`, Aliases: nil, - Description: `Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + Description: `Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadfederateddatabasequerylogs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivatenetworksettingendpointid. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-getGroupPrivateNetworkSettingEndpointId/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz`, + URL: `/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}`, QueryParameters: []shared_api.Parameter{ { - Name: `endDate`, - Description: `Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, + 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: `int`, + Type: `bool`, }, }, { - Name: `startDate`, - Description: `Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, + 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: `int`, + Type: `bool`, }, }, }, @@ -9874,8 +10013,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `tenantName`, - Description: `Human-readable label that identifies the federated database instance for which you want to download query logs.`, + Name: `endpointId`, + Description: `Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -9891,22 +10030,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: ``, ResponseContentTypes: []string{ - `gzip`, + `json`, }, }, }, }, { - OperationID: `getDataFederationPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `listGroupDataFederation`, + ShortOperationID: `listDataFederation`, Aliases: nil, - Description: `Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + Description: `Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatafederationprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatafederation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-listGroupDataFederation/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}`, + URL: `/api/atlas/v2/groups/{groupId}/dataFederation`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9928,6 +10067,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `type`, + Description: `Type of Federated Database Instances to return.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, URLParameters: []shared_api.Parameter{ { @@ -9944,16 +10093,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `endpointId`, - Description: `Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -9968,16 +10107,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getFederatedDatabase`, - ShortOperationID: ``, + OperationID: `listGroupDataFederationLimits`, + ShortOperationID: `listDataFederationLimits`, Aliases: nil, - Description: `Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. + Description: `Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederateddatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatafederationlimits. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-getFederatedDatabase/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-listGroupDataFederationLimits/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}`, + URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -9989,6 +10128,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -10007,7 +10156,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the Federated Database to return.`, + Description: `Human-readable label that identifies the federated database instance for which you want to retrieve query limits.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -10029,14 +10178,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDataFederationPrivateEndpoints`, - ShortOperationID: ``, + OperationID: `listGroupPrivateNetworkSettingEndpointIds`, + ShortOperationID: `listPrivateEndpointIds`, Aliases: nil, Description: `Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatafederationprivateendpoints. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivatenetworksettingendpointids. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-listGroupPrivateNetworkSettingEndpointIds/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds`, QueryParameters: []shared_api.Parameter{ @@ -10120,85 +10269,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listFederatedDatabases`, - ShortOperationID: ``, + OperationID: `setGroupDataFederationLimit`, + ShortOperationID: `setDataFederationLimit`, Aliases: nil, - Description: `Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederateddatabases. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-listFederatedDatabases/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation`, - 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: `type`, - Description: `Type of Federated Database Instances to return.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - 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`}, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `returnFederatedDatabaseQueryLimit`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgroupdatafederationlimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-setGroupDataFederationLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -10212,16 +10290,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -10267,83 +10335,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `returnFederatedDatabaseQueryLimits`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnfederateddatabasequerylimits. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits`, - 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: `tenantName`, - Description: `Human-readable label that identifies the federated database instance for which you want to retrieve query limits.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -10351,14 +10348,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateFederatedDatabase`, - ShortOperationID: ``, + OperationID: `updateGroupDataFederation`, + ShortOperationID: `updateDataFederation`, Aliases: nil, Description: `Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederateddatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupdatafederation. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-updateFederatedDatabase/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-dataFederation-updateGroupDataFederation/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}`, QueryParameters: []shared_api.Parameter{ @@ -10438,14 +10435,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes database users.`, Commands: []shared_api.Command{ { - OperationID: `createDatabaseUser`, - ShortOperationID: ``, + OperationID: `createGroupDatabaseUser`, + ShortOperationID: `createDatabaseUser`, Aliases: nil, Description: `Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatabaseuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-createDatabaseUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-createGroupDatabaseUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers`, QueryParameters: []shared_api.Parameter{ @@ -10499,14 +10496,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteDatabaseUser`, - ShortOperationID: ``, + OperationID: `deleteGroupDatabaseUser`, + ShortOperationID: `deleteDatabaseUser`, Aliases: nil, Description: `Removes one database user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletedatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupdatabaseuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-deleteDatabaseUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-deleteGroupDatabaseUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}`, QueryParameters: []shared_api.Parameter{ @@ -10593,14 +10590,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getDatabaseUser`, - ShortOperationID: ``, + OperationID: `getGroupDatabaseUser`, + ShortOperationID: `getDatabaseUser`, Aliases: nil, Description: `Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdatabaseuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-getDatabaseUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-getGroupDatabaseUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}`, QueryParameters: []shared_api.Parameter{ @@ -10687,14 +10684,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDatabaseUsers`, - ShortOperationID: ``, + OperationID: `listGroupDatabaseUsers`, + ShortOperationID: `listDatabaseUsers`, Aliases: nil, Description: `Returns all database users that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatabaseusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-listDatabaseUsers/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-listGroupDatabaseUsers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers`, QueryParameters: []shared_api.Parameter{ @@ -10778,14 +10775,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateDatabaseUser`, - ShortOperationID: ``, + OperationID: `updateGroupDatabaseUser`, + ShortOperationID: `updateDatabaseUser`, Aliases: nil, Description: `Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatedatabaseuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupdatabaseuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-updateDatabaseUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-databaseUsers-updateGroupDatabaseUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}`, QueryParameters: []shared_api.Parameter{ @@ -10878,14 +10875,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.`, Commands: []shared_api.Command{ { - OperationID: `createEncryptionAtRestPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `createGroupEncryptionAtRestPrivateEndpoint`, + ShortOperationID: `createRestPrivateEndpoint`, Aliases: nil, Description: `Creates a private endpoint in the specified region for encryption at rest using customer key management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createencryptionatrestprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupencryptionatrestprivateendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createGroupEncryptionAtRestPrivateEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints`, QueryParameters: []shared_api.Parameter{ @@ -10949,17 +10946,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getEncryptionAtRest`, - ShortOperationID: ``, + OperationID: `getGroupEncryptionAtRest`, + ShortOperationID: `getEncryptionAtRest`, Aliases: nil, Description: `Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrest. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupencryptionatrest. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getGroupEncryptionAtRest/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest`, QueryParameters: []shared_api.Parameter{ @@ -11013,14 +11010,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getEncryptionAtRestPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `getGroupEncryptionAtRestPrivateEndpoint`, + ShortOperationID: `getRestPrivateEndpoint`, Aliases: nil, Description: `Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupencryptionatrestprivateendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getGroupEncryptionAtRestPrivateEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -11094,14 +11091,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getEncryptionAtRestPrivateEndpointsForCloudProvider`, - ShortOperationID: ``, + OperationID: `listGroupEncryptionAtRestPrivateEndpoints`, + ShortOperationID: `listRestPrivateEndpoints`, Aliases: nil, Description: `Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getencryptionatrestprivateendpointsforcloudprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupencryptionatrestprivateendpoints. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-listGroupEncryptionAtRestPrivateEndpoints/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints`, QueryParameters: []shared_api.Parameter{ @@ -11195,14 +11192,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `requestEncryptionAtRestPrivateEndpointDeletion`, - ShortOperationID: ``, + OperationID: `requestGroupEncryptionAtRestPrivateEndpointDeletion`, + ShortOperationID: `requestPrivateEndpointDeletion`, Aliases: nil, Description: `Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-requestencryptionatrestprivateendpointdeletion. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-requestgroupencryptionatrestprivateendpointdeletion. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestGroupEncryptionAtRestPrivateEndpointDeletion/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -11276,17 +11273,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateEncryptionAtRest`, - ShortOperationID: ``, + OperationID: `updateGroupEncryptionAtRest`, + ShortOperationID: `updateEncryptionAtRest`, Aliases: nil, Description: `Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateencryptionatrest. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupencryptionatrest. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateGroupEncryptionAtRest/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/encryptionAtRest`, QueryParameters: []shared_api.Parameter{ @@ -11346,19 +11343,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns events. This collection remains under revision and may change.`, Commands: []shared_api.Command{ { - OperationID: `getOrganizationEvent`, + OperationID: `getGroupEvent`, ShortOperationID: ``, Aliases: nil, - Description: `Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. + Description: `Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationevent. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupevent. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-getOrganizationEvent/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-getGroupEvent/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/events/{eventId}`, + URL: `/api/atlas/v2/groups/{groupId}/events/{eventId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11393,14 +11390,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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: `eventId`, @@ -11426,19 +11427,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getProjectEvent`, + OperationID: `getOrgEvent`, ShortOperationID: ``, Aliases: nil, - Description: `Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. + Description: `Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectevent. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgevent. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-getProjectEvent/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-getOrgEvent/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/events/{eventId}`, + URL: `/api/atlas/v2/orgs/{orgId}/events/{eventId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11473,18 +11474,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `eventId`, @@ -11586,19 +11583,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizationEvents`, + OperationID: `listGroupEvents`, ShortOperationID: ``, Aliases: nil, - Description: `Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + Description: `Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationevents. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupevents. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-listOrganizationEvents/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-listGroupEvents/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/events`, + URL: `/api/atlas/v2/groups/{groupId}/events`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11650,6 +11647,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `clusterNames`, + Description: `Human-readable label that identifies the cluster.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, { Name: `eventType`, Description: `Category of incident recorded at this moment in time. @@ -11663,6 +11670,19 @@ IMPORTANT: The complete list of event type values changes frequently.`, Type: `string`, }, }, + { + Name: `excludedEventType`, + Description: `Category of event that you would like to exclude from query results, such as CLUSTER_CREATED + + +IMPORTANT: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, { Name: `includeRaw`, Description: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, @@ -11696,14 +11716,18 @@ IMPORTANT: The complete list of event type values changes frequently.`, }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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`}, }, }, Verb: http.MethodGet, @@ -11719,19 +11743,19 @@ IMPORTANT: The complete list of event type values changes frequently.`, }, }, { - OperationID: `listProjectEvents`, + OperationID: `listOrgEvents`, ShortOperationID: ``, Aliases: nil, - Description: `Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This resource remains under revision and may change. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectevents. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgevents. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-listProjectEvents/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-events-listOrgEvents/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/events`, + URL: `/api/atlas/v2/orgs/{orgId}/events`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11783,16 +11807,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `clusterNames`, - Description: `Human-readable label that identifies the cluster.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: true, - Type: `string`, - }, - }, { Name: `eventType`, Description: `Category of incident recorded at this moment in time. @@ -11806,19 +11820,6 @@ IMPORTANT: The complete list of event type values changes frequently.`, Type: `string`, }, }, - { - Name: `excludedEventType`, - Description: `Category of event that you would like to exclude from query results, such as CLUSTER_CREATED - - -IMPORTANT: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: true, - Type: `string`, - }, - }, { Name: `includeRaw`, Description: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, @@ -11852,18 +11853,14 @@ IMPORTANT: Event type names change frequently. Verify that you specify the event }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, }, Verb: http.MethodGet, @@ -11885,19 +11882,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.`, Commands: []shared_api.Command{ { - OperationID: `createIdentityProvider`, - ShortOperationID: ``, + OperationID: `createFederationSettingConnectedOrgConfigRoleMapping`, + ShortOperationID: `createRoleMapping`, Aliases: nil, - Description: `Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - - -Note: This resource only supports the creation of OIDC identity providers. + Description: `Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederationsettingconnectedorgconfigrolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-createIdentityProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-createFederationSettingConnectedOrgConfigRoleMapping/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11921,12 +11915,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 11, 15), + Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -11935,16 +11939,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createRoleMapping`, - ShortOperationID: ``, + OperationID: `createFederationSettingIdentityProvider`, + ShortOperationID: `createIdentityProvider`, Aliases: nil, - Description: `Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-createRoleMapping/`, +Note: This resource only supports the creation of OIDC identity providers. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createfederationsettingidentityprovider. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-createFederationSettingIdentityProvider/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -11968,9 +11975,35 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + }, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 11, 15), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `deleteFederationSetting`, + ShortOperationID: ``, + Aliases: nil, + Description: `Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsetting. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteFederationSetting/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}`, + QueryParameters: []shared_api.Parameter{}, + URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `federationSettingsId`, + Description: `Unique 24-hexadecimal digit string that identifies your federation.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -11979,12 +12012,12 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -11992,17 +12025,28 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteFederationApp`, - ShortOperationID: ``, + OperationID: `deleteFederationSettingConnectedOrgConfigRoleMapping`, + ShortOperationID: `deleteRoleMapping`, Aliases: nil, - Description: `Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. + Description: `Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationapp. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsettingconnectedorgconfigrolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteFederationApp/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteFederationSettingConnectedOrgConfigRoleMapping/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}`, - QueryParameters: []shared_api.Parameter{}, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}`, + 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`, + }, + }, + }, URLParameters: []shared_api.Parameter{ { Name: `federationSettingsId`, @@ -12014,6 +12058,26 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `id`, + Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodDelete, }, @@ -12028,17 +12092,17 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteIdentityProvider`, - ShortOperationID: ``, + OperationID: `deleteFederationSettingIdentityProvider`, + ShortOperationID: `deleteIdentityProvider`, Aliases: nil, Description: `Deletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletefederationsettingidentityprovider. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteIdentityProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteFederationSettingIdentityProvider/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}`, QueryParameters: []shared_api.Parameter{ @@ -12088,14 +12152,71 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteRoleMapping`, - ShortOperationID: ``, + OperationID: `getFederationSettingConnectedOrgConfig`, + ShortOperationID: `getConnectedOrgConfig`, Aliases: nil, - Description: `Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingconnectedorgconfig. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getFederationSettingConnectedOrgConfig/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}`, + 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`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ + { + Name: `federationSettingsId`, + Description: `Unique 24-hexadecimal digit string that identifies your federation.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.`, + 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: `getFederationSettingConnectedOrgConfigRoleMapping`, + ShortOperationID: `getRoleMapping`, + Aliases: nil, + Description: `Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleterolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingconnectedorgconfigrolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-deleteRoleMapping/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getFederationSettingConnectedOrgConfigRoleMapping/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}`, QueryParameters: []shared_api.Parameter{ @@ -12123,7 +12244,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, { Name: `id`, - Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.`, + Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -12142,7 +12263,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -12155,16 +12276,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getConnectedOrgConfig`, - ShortOperationID: ``, + OperationID: `getFederationSettingIdentityProvider`, + ShortOperationID: `getIdentityProvider`, Aliases: nil, - Description: `Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. + Description: `Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingidentityprovider. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getConnectedOrgConfig/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getFederationSettingIdentityProvider/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -12189,8 +12310,54 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.`, + Name: `identityProviderId`, + Description: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 11, 15), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getFederationSettingIdentityProviderMetadata`, + ShortOperationID: `getIdentityProviderMetadata`, + Aliases: nil, + Description: `Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingidentityprovidermetadata. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getFederationSettingIdentityProviderMetadata/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml`, + QueryParameters: []shared_api.Parameter{}, + URLParameters: []shared_api.Parameter{ + { + Name: `federationSettingsId`, + Description: `Unique 24-hexadecimal digit string that identifies your federation.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `identityProviderId`, + Description: `Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -12212,14 +12379,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getFederationSettings`, - ShortOperationID: ``, + OperationID: `getOrgFederationSettings`, + ShortOperationID: `getFederationSettings`, Aliases: nil, Description: `Returns information about the federation settings for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgfederationsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getFederationSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getOrgFederationSettings/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/federationSettings`, QueryParameters: []shared_api.Parameter{ @@ -12269,119 +12436,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getIdentityProvider`, - ShortOperationID: ``, + OperationID: `listFederationSettingConnectedOrgConfigRoleMappings`, + ShortOperationID: `listRoleMappings`, Aliases: nil, - Description: `Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovider. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getIdentityProvider/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}`, - 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`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `federationSettingsId`, - Description: `Unique 24-hexadecimal digit string that identifies your federation.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `identityProviderId`, - Description: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 11, 15), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `getIdentityProviderMetadata`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovidermetadata. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml`, - QueryParameters: []shared_api.Parameter{}, - URLParameters: []shared_api.Parameter{ - { - Name: `federationSettingsId`, - Description: `Unique 24-hexadecimal digit string that identifies your federation.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `identityProviderId`, - Description: `Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.`, - 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: `getRoleMapping`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getrolemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingconnectedorgconfigrolemappings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-getRoleMapping/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listFederationSettingConnectedOrgConfigRoleMappings/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -12405,16 +12469,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `id`, - Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, { Name: `orgId`, Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, @@ -12439,14 +12493,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listConnectedOrgConfigs`, - ShortOperationID: ``, + OperationID: `listFederationSettingConnectedOrgConfigs`, + ShortOperationID: `listConnectedOrgConfigs`, Aliases: nil, Description: `Returns all connected org configs in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listconnectedorgconfigs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingconnectedorgconfigs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listFederationSettingConnectedOrgConfigs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs`, QueryParameters: []shared_api.Parameter{ @@ -12506,14 +12560,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listIdentityProviders`, - ShortOperationID: ``, + OperationID: `listFederationSettingIdentityProviders`, + ShortOperationID: `listIdentityProviders`, Aliases: nil, Description: `Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listidentityproviders. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listfederationsettingidentityproviders. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listIdentityProviders/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listFederationSettingIdentityProviders/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders`, QueryParameters: []shared_api.Parameter{ @@ -12593,71 +12647,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listRoleMappings`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listrolemappings. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-listRoleMappings/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings`, - 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`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `federationSettingsId`, - Description: `Unique 24-hexadecimal digit string that identifies your federation.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - 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: `removeConnectedOrgConfig`, - ShortOperationID: ``, + OperationID: `removeFederationSettingConnectedOrgConfig`, + ShortOperationID: `removeConnectedOrgConfig`, Aliases: nil, Description: `Removes one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removefederationsettingconnectedorgconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-removeFederationSettingConnectedOrgConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}`, QueryParameters: []shared_api.Parameter{ @@ -12707,17 +12704,17 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `revokeJwksFromIdentityProvider`, - ShortOperationID: ``, + OperationID: `revokeFederationSettingIdentityProviderJwks`, + ShortOperationID: `revokeIdentityProviderJwks`, Aliases: nil, Description: `Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokejwksfromidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-revokefederationsettingidentityproviderjwks. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-revokeFederationSettingIdentityProviderJwks/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks`, QueryParameters: []shared_api.Parameter{ @@ -12767,8 +12764,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateConnectedOrgConfig`, - ShortOperationID: ``, + OperationID: `updateFederationSettingConnectedOrgConfig`, + ShortOperationID: `updateConnectedOrgConfig`, Aliases: nil, Description: `Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -12784,9 +12781,9 @@ Note: If the identityProviderId field is not provided, you will disconnect the o Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfig. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateFederationSettingConnectedOrgConfig/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}`, QueryParameters: []shared_api.Parameter{ @@ -12836,19 +12833,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateIdentityProvider`, - ShortOperationID: ``, + OperationID: `updateFederationSettingConnectedOrgConfigRoleMapping`, + ShortOperationID: `updateRoleMapping`, Aliases: nil, - Description: `Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - - -Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. + Description: `Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateidentityprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingconnectedorgconfigrolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateIdentityProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateFederationSettingConnectedOrgConfigRoleMapping/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -12873,8 +12867,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `identityProviderId`, - Description: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, + Name: `id`, + Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -12883,11 +12887,11 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 11, 15), + Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -12896,16 +12900,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateRoleMapping`, - ShortOperationID: ``, + OperationID: `updateFederationSettingIdentityProvider`, + ShortOperationID: `updateIdentityProvider`, Aliases: nil, - Description: `Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updaterolemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateRoleMapping/`, +Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatefederationsettingidentityprovider. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-federatedAuthentication-updateFederationSettingIdentityProvider/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}`, + URL: `/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -12930,18 +12937,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `id`, - Description: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `identityProviderId`, + Description: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -12950,11 +12947,11 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPut, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), + Version: shared_api.NewStableVersion(2023, 11, 15), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -12969,14 +12966,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Returns, adds, edits, and removes flex clusters.`, Commands: []shared_api.Command{ { - OperationID: `createFlexCluster`, - ShortOperationID: ``, + OperationID: `createGroupFlexCluster`, + ShortOperationID: `createFlexCluster`, Aliases: nil, Description: `Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupflexcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-createFlexCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-createGroupFlexCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters`, QueryParameters: []shared_api.Parameter{ @@ -13030,11 +13027,10 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, + OperationID: `createGroupFlexCluster`, Version: shared_api.NewStableVersion(2024, 11, 13), Params: map[string]string{ `groupId`: `input:groupId`, - `name`: `body:$.name`, }, }, Expect: &shared_api.WatcherExpectProperties{ @@ -13049,14 +13045,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteFlexCluster`, - ShortOperationID: ``, + OperationID: `deleteGroupFlexCluster`, + ShortOperationID: `deleteFlexCluster`, Aliases: nil, Description: `Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupflexcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-deleteFlexCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-deleteGroupFlexCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}`, QueryParameters: []shared_api.Parameter{ @@ -13120,7 +13116,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, + OperationID: `deleteGroupFlexCluster`, Version: shared_api.NewStableVersion(2024, 11, 13), Params: map[string]string{ `groupId`: `input:groupId`, @@ -13134,14 +13130,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getFlexCluster`, - ShortOperationID: ``, + OperationID: `getGroupFlexCluster`, + ShortOperationID: `getFlexCluster`, Aliases: nil, Description: `Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-getFlexCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-getGroupFlexCluster/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}`, QueryParameters: []shared_api.Parameter{ @@ -13205,14 +13201,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listFlexClusters`, - ShortOperationID: ``, + OperationID: `listGroupFlexClusters`, + ShortOperationID: `listFlexClusters`, Aliases: nil, Description: `Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexclusters. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusters. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-listFlexClusters/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-listGroupFlexClusters/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters`, QueryParameters: []shared_api.Parameter{ @@ -13296,16 +13292,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateFlexCluster`, - ShortOperationID: ``, + OperationID: `tenantGroupFlexClusterUpgrade`, + ShortOperationID: `tenantUpgrade`, Aliases: nil, - Description: `Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-tenantgroupflexclusterupgrade. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-updateFlexCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-tenantGroupFlexClusterUpgrade/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}`, + URL: `/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -13343,18 +13339,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `name`, - Description: `Human-readable label that identifies the flex cluster.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPatch, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -13365,36 +13351,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, - Version: shared_api.NewStableVersion(2024, 11, 13), - Params: map[string]string{ - `groupId`: `input:groupId`, - `name`: `input:name`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.stateName`, - Values: []string{ - `IDLE`, - }, - }, - }, - }, }, { - OperationID: `upgradeFlexCluster`, - ShortOperationID: ``, + OperationID: `updateGroupFlexCluster`, + ShortOperationID: `updateFlexCluster`, Aliases: nil, - Description: `Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. + Description: `Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-upgradeflexcluster. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupflexcluster. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-upgradeFlexCluster/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexClusters-updateGroupFlexCluster/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade`, + URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -13432,8 +13400,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `name`, + Description: `Human-readable label that identifies the flex cluster.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPost, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { @@ -13444,6 +13422,24 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `updateGroupFlexCluster`, + Version: shared_api.NewStableVersion(2024, 11, 13), + Params: map[string]string{ + `groupId`: `input:groupId`, + `name`: `input:name`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.stateName`, + Values: []string{ + `IDLE`, + }, + }, + }, + }, }, }, }, @@ -13452,14 +13448,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and adds restore jobs for flex database deployments.`, Commands: []shared_api.Command{ { - OperationID: `createFlexBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupFlexClusterBackupRestoreJob`, + ShortOperationID: `createFlexRestoreJob`, Aliases: nil, Description: `Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createflexbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupflexclusterbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-createGroupFlexClusterBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -13523,12 +13519,11 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexBackupRestoreJob`, + OperationID: `createGroupFlexClusterBackupRestoreJob`, Version: shared_api.NewStableVersion(2024, 11, 13), Params: map[string]string{ - `groupId`: `input:groupId`, - `name`: `input:name`, - `restoreJobId`: `body:$.id`, + `groupId`: `input:groupId`, + `name`: `input:name`, }, }, Expect: &shared_api.WatcherExpectProperties{ @@ -13543,14 +13538,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getFlexBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `getGroupFlexClusterBackupRestoreJob`, + ShortOperationID: `getFlexRestoreJob`, Aliases: nil, Description: `Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexclusterbackuprestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-getGroupFlexClusterBackupRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}`, QueryParameters: []shared_api.Parameter{ @@ -13624,14 +13619,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listFlexBackupRestoreJobs`, - ShortOperationID: ``, + OperationID: `listGroupFlexClusterBackupRestoreJobs`, + ShortOperationID: `listFlexRestoreJobs`, Aliases: nil, Description: `Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusterbackuprestorejobs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexRestoreJobs-listGroupFlexClusterBackupRestoreJobs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -13731,14 +13726,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and requests to download flex database deployment snapshots.`, Commands: []shared_api.Command{ { - OperationID: `downloadFlexBackup`, - ShortOperationID: ``, + OperationID: `downloadGroupFlexClusterBackup`, + ShortOperationID: `downloadFlexBackup`, Aliases: nil, Description: `Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadflexbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupflexclusterbackup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-downloadFlexBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-downloadGroupFlexClusterBackup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download`, QueryParameters: []shared_api.Parameter{ @@ -13802,14 +13797,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getFlexBackup`, - ShortOperationID: ``, + OperationID: `getGroupFlexClusterBackupSnapshot`, + ShortOperationID: `getFlexBackupSnapshot`, Aliases: nil, Description: `Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getflexbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupflexclusterbackupsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-getFlexBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-getGroupFlexClusterBackupSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -13873,14 +13868,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listFlexBackups`, - ShortOperationID: ``, + OperationID: `listGroupFlexClusterBackupSnapshots`, + ShortOperationID: `listFlexBackupSnapshots`, Aliases: nil, Description: `Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listflexbackups. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupflexclusterbackupsnapshots. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-listFlexBackups/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-flexSnapshots-listGroupFlexClusterBackupSnapshots/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots`, QueryParameters: []shared_api.Parameter{ @@ -13981,14 +13976,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is city, the compound shard key is location, city. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the Global Cluster Configuration pane when you create or modify your Global Cluster.`, Commands: []shared_api.Command{ { - OperationID: `createCustomZoneMapping`, - ShortOperationID: ``, + OperationID: `createGroupClusterGlobalWriteCustomZoneMapping`, + ShortOperationID: `createCustomZoneMapping`, Aliases: nil, Description: `Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcustomzonemapping. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterglobalwritecustomzonemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-createCustomZoneMapping/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-createGroupClusterGlobalWriteCustomZoneMapping/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping`, QueryParameters: []shared_api.Parameter{ @@ -14066,14 +14061,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createManagedNamespace`, - ShortOperationID: ``, + OperationID: `createGroupClusterGlobalWriteManagedNamespace`, + ShortOperationID: `createManagedNamespace`, Aliases: nil, Description: `Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createmanagednamespace. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterglobalwritemanagednamespace. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-createManagedNamespace/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-createGroupClusterGlobalWriteManagedNamespace/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces`, QueryParameters: []shared_api.Parameter{ @@ -14151,14 +14146,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteAllCustomZoneMappings`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterGlobalWriteCustomZoneMapping`, + ShortOperationID: `deleteCustomZoneMapping`, Aliases: nil, Description: `Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteallcustomzonemappings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterglobalwritecustomzonemapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-deleteAllCustomZoneMappings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-deleteGroupClusterGlobalWriteCustomZoneMapping/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping`, QueryParameters: []shared_api.Parameter{ @@ -14236,14 +14231,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteManagedNamespace`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterGlobalWriteManagedNamespaces`, + ShortOperationID: `deleteManagedNamespaces`, Aliases: nil, Description: `Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletemanagednamespace. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusterglobalwritemanagednamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-deleteManagedNamespace/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-deleteGroupClusterGlobalWriteManagedNamespaces/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces`, QueryParameters: []shared_api.Parameter{ @@ -14341,14 +14336,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getManagedNamespace`, - ShortOperationID: ``, + OperationID: `getGroupClusterGlobalWrites`, + ShortOperationID: `getClusterGlobalWrites`, Aliases: nil, Description: `Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmanagednamespace. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterglobalwrites. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-getManagedNamespace/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-globalClusters-getGroupClusterGlobalWrites/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites`, QueryParameters: []shared_api.Parameter{ @@ -14432,14 +14427,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns invoices.`, Commands: []shared_api.Command{ { - OperationID: `createCostExplorerQueryProcess`, - ShortOperationID: ``, + OperationID: `createOrgBillingCostExplorerUsageProcess`, + ShortOperationID: `createCostExplorerProcess`, Aliases: nil, Description: `Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcostexplorerqueryprocess. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgbillingcostexplorerusageprocess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-createCostExplorerQueryProcess/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-createOrgBillingCostExplorerUsageProcess/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage`, QueryParameters: []shared_api.Parameter{ @@ -14479,17 +14474,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `downloadInvoiceCsv`, - ShortOperationID: ``, + OperationID: `getOrgBillingCostExplorerUsage`, + ShortOperationID: `getCostExplorerUsage`, Aliases: nil, - Description: `Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. -To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. + Description: `Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadinvoicecsv. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgbillingcostexplorerusage. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-downloadInvoiceCsv/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-getOrgBillingCostExplorerUsage/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv`, + URL: `/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -14501,16 +14495,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -14524,8 +14508,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `invoiceId`, - Description: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + Name: `token`, + Description: `Unique 64 digit string that identifies the Cost Explorer query.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -14542,21 +14526,23 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c RequestContentType: ``, ResponseContentTypes: []string{ `csv`, + `json`, }, }, }, }, { - OperationID: `getCostExplorerQueryProcess`, - ShortOperationID: ``, + OperationID: `getOrgInvoice`, + ShortOperationID: `getInvoice`, Aliases: nil, - Description: `Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. + Description: `Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. +To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcostexplorerqueryprocess. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoice. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-getCostExplorerQueryProcess/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-getOrgInvoice/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}`, + URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -14568,6 +14554,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -14581,8 +14577,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `token`, - Description: `Unique 64 digit string that identifies the Cost Explorer query.`, + Name: `invoiceId`, + Description: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -14605,17 +14601,17 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getInvoice`, - ShortOperationID: ``, + OperationID: `getOrgInvoiceCsv`, + ShortOperationID: `getInvoiceCsv`, Aliases: nil, - Description: `Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. + Description: `Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getinvoice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoicecsv. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-getInvoice/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-getOrgInvoiceCsv/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}`, + URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -14668,21 +14664,77 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c RequestContentType: ``, ResponseContentTypes: []string{ `csv`, + }, + }, + }, + }, + { + OperationID: `listOrgInvoicePending`, + ShortOperationID: `listInvoicePending`, + Aliases: nil, + Description: `Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvoicepending. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-listOrgInvoicePending/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/orgs/{orgId}/invoices/pending`, + 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: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + 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: `listInvoices`, - ShortOperationID: ``, + OperationID: `listOrgInvoices`, + ShortOperationID: `listInvoices`, Aliases: nil, Description: `Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listinvoices. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvoices. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-listInvoices/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-listOrgInvoices/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/invoices`, QueryParameters: []shared_api.Parameter{ @@ -14822,16 +14874,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listPendingInvoices`, - ShortOperationID: ``, + OperationID: `searchOrgInvoiceLineItems`, + ShortOperationID: `searchInvoiceLineItems`, Aliases: nil, - Description: `Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. + Description: `Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpendinginvoices. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-searchorginvoicelineitems. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-listPendingInvoices/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-searchOrgInvoiceLineItems/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invoices/pending`, + URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -14844,13 +14896,23 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, }, }, }, @@ -14865,30 +14927,46 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `invoiceId`, + Description: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + 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: ``, + Version: shared_api.NewStableVersion(2024, 8, 5), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `LDAP Configuration`, + Description: `Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.`, + Commands: []shared_api.Command{ { - OperationID: `queryLineItemsFromSingleInvoice`, - ShortOperationID: ``, + OperationID: `deleteGroupUserSecurityLdapUserToDnMapping`, + ShortOperationID: `deleteLdapUserMapping`, Aliases: nil, - Description: `Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. + Description: `Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-querylineitemsfromsingleinvoice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupusersecurityldapusertodnmapping. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-invoices-queryLineItemsFromSingleInvoice/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-deleteGroupUserSecurityLdapUserToDnMapping/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search`, + URL: `/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -14901,77 +14979,55 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, + 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: `int`, + Type: `bool`, }, }, }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `invoiceId`, - Description: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, - Short: ``, - Required: true, + 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`}, }, }, - Verb: http.MethodGet, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: `json`, + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, }, - }, - }, - { - Name: `LDAP Configuration`, - Description: `Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.`, - Commands: []shared_api.Command{ { - OperationID: `deleteLdapConfiguration`, - ShortOperationID: ``, + OperationID: `getGroupUserSecurity`, + ShortOperationID: `getUserSecurity`, Aliases: nil, - Description: `Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns the current LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteldapconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupusersecurity. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-deleteLdapConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-getGroupUserSecurity/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping`, + URL: `/api/atlas/v2/groups/{groupId}/userSecurity`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -15010,7 +15066,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -15023,16 +15079,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLdapConfiguration`, - ShortOperationID: ``, + OperationID: `getGroupUserSecurityLdapVerify`, + ShortOperationID: `getUserSecurityVerify`, Aliases: nil, - Description: `Returns the current LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupusersecurityldapverify. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-getLdapConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-getGroupUserSecurityLdapVerify/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/userSecurity`, + URL: `/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -15070,6 +15126,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `requestId`, + Description: `Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -15084,90 +15150,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLdapConfigurationStatus`, - ShortOperationID: ``, + OperationID: `updateGroupUserSecurity`, + ShortOperationID: `updateUserSecurity`, Aliases: nil, - Description: `Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getldapconfigurationstatus. +Updating this configuration triggers a rolling restart of the database. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupusersecurity. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-updateGroupUserSecurity/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}`, - 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: `requestId`, - Description: `Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.`, - 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: `saveLdapConfiguration`, - ShortOperationID: ``, - Aliases: nil, - Description: `Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Updating this configuration triggers a rolling restart of the database. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-saveldapconfiguration. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-saveLdapConfiguration/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/userSecurity`, + URL: `/api/atlas/v2/groups/{groupId}/userSecurity`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -15219,14 +15214,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `verifyLdapConfiguration`, - ShortOperationID: ``, + OperationID: `verifyGroupUserSecurityLdap`, + ShortOperationID: `verifyUserSecurityLdap`, Aliases: nil, Description: `Verifies the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyldapconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifygroupusersecurityldap. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-verifyLdapConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-ldapConfiguration-verifyGroupUserSecurityLdap/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify`, QueryParameters: []shared_api.Parameter{ @@ -15280,11 +15275,10 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getLdapConfigurationStatus`, + OperationID: `verifyGroupUserSecurityLdap`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ - `groupId`: `input:groupId`, - `requestId`: `body:$.requestId`, + `groupId`: `input:groupId`, }, }, Expect: &shared_api.WatcherExpectProperties{ @@ -15305,14 +15299,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.`, Commands: []shared_api.Command{ { - OperationID: `createLegacyBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupClusterRestoreJob`, + ShortOperationID: `createClusterRestoreJob`, Aliases: nil, Description: `Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createlegacybackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterrestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-createGroupClusterRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -15376,14 +15370,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteLegacySnapshot`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterSnapshot`, + ShortOperationID: `deleteClusterSnapshot`, Aliases: nil, Description: `Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletelegacysnapshot. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclustersnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-deleteLegacySnapshot/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-deleteGroupClusterSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -15457,14 +15451,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLegacyBackupCheckpoint`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupCheckpoint`, + ShortOperationID: `getClusterBackupCheckpoint`, Aliases: nil, Description: `Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacybackupcheckpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackupcheckpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getGroupClusterBackupCheckpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}`, QueryParameters: []shared_api.Parameter{ @@ -15538,17 +15532,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLegacyBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `getGroupClusterRestoreJob`, + ShortOperationID: `getClusterRestoreJob`, Aliases: nil, Description: `Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacybackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterrestorejob. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getGroupClusterRestoreJob/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}`, QueryParameters: []shared_api.Parameter{ @@ -15622,14 +15616,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLegacySnapshot`, - ShortOperationID: ``, + OperationID: `getGroupClusterSnapshot`, + ShortOperationID: `getClusterSnapshot`, Aliases: nil, Description: `Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacysnapshot. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getLegacySnapshot/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getGroupClusterSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -15703,17 +15697,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getLegacySnapshotSchedule`, - ShortOperationID: ``, + OperationID: `getGroupClusterSnapshotSchedule`, + ShortOperationID: `getClusterSnapshotSchedule`, Aliases: nil, Description: `Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getlegacysnapshotschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclustersnapshotschedule. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getLegacySnapshotSchedule/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-getGroupClusterSnapshotSchedule/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule`, QueryParameters: []shared_api.Parameter{ @@ -15777,14 +15771,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listLegacyBackupCheckpoints`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupCheckpoints`, + ShortOperationID: `listClusterBackupCheckpoints`, Aliases: nil, Description: `Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacybackupcheckpoints. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackupcheckpoints. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listGroupClusterBackupCheckpoints/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints`, QueryParameters: []shared_api.Parameter{ @@ -15878,17 +15872,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listLegacyBackupRestoreJobs`, - ShortOperationID: ``, + OperationID: `listGroupClusterRestoreJobs`, + ShortOperationID: `listClusterRestoreJobs`, Aliases: nil, Description: `Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacybackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterrestorejobs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listGroupClusterRestoreJobs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs`, QueryParameters: []shared_api.Parameter{ @@ -15992,14 +15986,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listLegacySnapshots`, - ShortOperationID: ``, + OperationID: `listGroupClusterSnapshots`, + ShortOperationID: `listClusterSnapshots`, Aliases: nil, Description: `Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacysnapshots. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustersnapshots. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listLegacySnapshots/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-listGroupClusterSnapshots/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots`, QueryParameters: []shared_api.Parameter{ @@ -16103,14 +16097,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateLegacySnapshotRetention`, - ShortOperationID: ``, + OperationID: `updateGroupClusterSnapshot`, + ShortOperationID: `updateClusterSnapshot`, Aliases: nil, Description: `Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatelegacysnapshotretention. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-updateLegacySnapshotRetention/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-updateGroupClusterSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -16184,17 +16178,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateLegacySnapshotSchedule`, - ShortOperationID: ``, + OperationID: `updateGroupClusterSnapshotSchedule`, + ShortOperationID: `updateClusterSnapshotSchedule`, Aliases: nil, Description: `Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatelegacysnapshotschedule. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclustersnapshotschedule. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-legacyBackup-updateGroupClusterSnapshotSchedule/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule`, QueryParameters: []shared_api.Parameter{ @@ -16264,14 +16258,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.`, Commands: []shared_api.Command{ { - OperationID: `deferMaintenanceWindow`, - ShortOperationID: ``, + OperationID: `deferGroupMaintenanceWindow`, + ShortOperationID: `deferMaintenanceWindow`, Aliases: nil, Description: `Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-defermaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-defergroupmaintenancewindow. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-deferMaintenanceWindow/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-deferGroupMaintenanceWindow/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer`, QueryParameters: []shared_api.Parameter{ @@ -16315,14 +16309,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getMaintenanceWindow`, - ShortOperationID: ``, + OperationID: `getGroupMaintenanceWindow`, + ShortOperationID: `getMaintenanceWindow`, Aliases: nil, Description: `Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupmaintenancewindow. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-getMaintenanceWindow/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-getGroupMaintenanceWindow/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/maintenanceWindow`, QueryParameters: []shared_api.Parameter{ @@ -16376,14 +16370,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `resetMaintenanceWindow`, - ShortOperationID: ``, + OperationID: `resetGroupMaintenanceWindow`, + ShortOperationID: `resetMaintenanceWindow`, Aliases: nil, Description: `Resets the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resetmaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-resetgroupmaintenancewindow. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-resetMaintenanceWindow/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-resetGroupMaintenanceWindow/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/maintenanceWindow`, QueryParameters: []shared_api.Parameter{ @@ -16427,14 +16421,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `toggleMaintenanceAutoDefer`, - ShortOperationID: ``, + OperationID: `toggleGroupMaintenanceWindowAutoDefer`, + ShortOperationID: `toggleMaintenanceAutoDefer`, Aliases: nil, Description: `Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglemaintenanceautodefer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupmaintenancewindowautodefer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-toggleGroupMaintenanceWindowAutoDefer/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer`, QueryParameters: []shared_api.Parameter{ @@ -16478,14 +16472,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateMaintenanceWindow`, - ShortOperationID: ``, + OperationID: `updateGroupMaintenanceWindow`, + ShortOperationID: `updateMaintenanceWindow`, Aliases: nil, Description: `Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatemaintenancewindow. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupmaintenancewindow. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-updateMaintenanceWindow/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-maintenanceWindows-updateGroupMaintenanceWindow/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/maintenanceWindow`, QueryParameters: []shared_api.Parameter{ @@ -16535,80 +16529,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, and edits MongoDB Cloud users.`, Commands: []shared_api.Command{ { - OperationID: `addOrganizationRole`, - ShortOperationID: ``, - Aliases: nil, - Description: `Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: This operation is atomic. - - -Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorganizationrole. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addOrganizationRole/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole`, - 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: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2025, 2, 19), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `addProjectRole`, + OperationID: `addGroupUserRole`, ShortOperationID: ``, Aliases: nil, Description: `Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -16616,9 +16537,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectrole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupuserrole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addProjectRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addGroupUserRole/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/users/{userId}:addRole`, QueryParameters: []shared_api.Parameter{ @@ -16682,7 +16603,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `addProjectUser`, + OperationID: `addGroupUsers`, ShortOperationID: ``, Aliases: nil, Description: `Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -16697,9 +16618,9 @@ If the user doesn't have an invitation to join the organization, MongoDB Cloud s If the user is already active in the project's organization, MongoDB Cloud grants access to the project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addProjectUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addGroupUsers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/users`, QueryParameters: []shared_api.Parameter{ @@ -16753,7 +16674,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `addUserToTeam`, + OperationID: `addOrgTeamUser`, ShortOperationID: ``, Aliases: nil, Description: `Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -16761,9 +16682,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addusertoteam. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorgteamuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addUserToTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addOrgTeamUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser`, QueryParameters: []shared_api.Parameter{ @@ -16823,19 +16744,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createOrganizationUser`, - ShortOperationID: ``, + OperationID: `addOrgUserRole`, + ShortOperationID: `addOrgRole`, Aliases: nil, - Description: `Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. +Note: This operation is atomic. + -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganizationuser. +Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorguserrole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-createOrganizationUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-addOrgUserRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users`, + URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -16869,64 +16793,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2025, 2, 19), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `createUser`, - ShortOperationID: ``, - Aliases: nil, - Description: `Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. - - -MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. - - -To use this resource, the requesting Service Account or API Key can have any role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createuser. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-createUser/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/users`, - 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.`, + Name: `userId`, + Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, Short: ``, - Required: false, + Required: true, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `string`, }, }, }, - URLParameters: []shared_api.Parameter{}, - Verb: http.MethodPost, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), + Version: shared_api.NewStableVersion(2025, 2, 19), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -16935,22 +16817,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getOrganizationUser`, + OperationID: `createOrgUser`, ShortOperationID: ``, Aliases: nil, - Description: `Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - - -Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. + Description: `Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. +Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorguser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getOrganizationUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-createOrgUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}`, + URL: `/api/atlas/v2/orgs/{orgId}/users`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -16984,23 +16863,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2025, 2, 19), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -17008,22 +16877,74 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getProjectUser`, + OperationID: `createUser`, ShortOperationID: ``, Aliases: nil, - Description: `Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. -Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. +MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. -Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. +To use this resource, the requesting Service Account or API Key can have any role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getProjectUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-createUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/users/{userId}`, + URL: `/api/atlas/v2/users`, + 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{}, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getGroupUser`, + ShortOperationID: ``, + Aliases: nil, + Description: `Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + + +Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. + + +Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupuser. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getGroupUser/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/users/{userId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17085,16 +17006,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getUser`, + OperationID: `getOrgUser`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. + Description: `Returns information about the specified MongoDB Cloud user within the context of the specified organization. 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-getuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getUser/`, +Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. + + +Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorguser. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getOrgUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/users/{userId}`, + URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17118,9 +17045,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, URLParameters: []shared_api.Parameter{ + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, { Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies this user.`, + Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17133,7 +17070,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), + Version: shared_api.NewStableVersion(2025, 2, 19), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -17142,16 +17079,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getUserByUsername`, + OperationID: `getUser`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. + Description: `Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyusername. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getUserByUsername/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/users/byName/{userName}`, + URL: `/api/atlas/v2/users/{userId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17176,8 +17113,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `userName`, - Description: `Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.`, + Name: `userId`, + Description: `Unique 24-hexadecimal digit string that identifies this user.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17199,22 +17136,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizationUsers`, + OperationID: `getUserByName`, ShortOperationID: ``, Aliases: nil, - Description: `Returns details about the pending and active MongoDB Cloud users associated with the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - - -Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. - - -Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. + Description: `Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-getUserByName/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users`, + URL: `/api/atlas/v2/users/byName/{userName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17236,61 +17167,11 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `username`, - Description: `Email address to filter users by. Not supported in deprecated versions.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `orgMembershipStatus`, - Description: `Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `userName`, + Description: `Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17309,17 +17190,10 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c `json`, }, }, - { - Version: shared_api.NewStableVersion(2025, 2, 19), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, }, }, { - OperationID: `listProjectUsers`, + OperationID: `listGroupUsers`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about the pending and active MongoDB Cloud users associated with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -17330,9 +17204,9 @@ Note: This resource cannot be used to view details about users invited via the d Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listProjectUsers/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listGroupUsers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/users`, QueryParameters: []shared_api.Parameter{ @@ -17463,8 +17337,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listTeamUsers`, - ShortOperationID: ``, + OperationID: `listOrgTeamUsers`, + ShortOperationID: `listTeamUsers`, Aliases: nil, Description: `Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -17474,9 +17348,9 @@ Note: This resource cannot be used to view details about users invited via the d Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listteamusers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgteamusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listTeamUsers/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listOrgTeamUsers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users`, QueryParameters: []shared_api.Parameter{ @@ -17593,22 +17467,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `removeOrganizationRole`, + OperationID: `listOrgUsers`, ShortOperationID: ``, Aliases: nil, - Description: `Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Returns details about the pending and active MongoDB Cloud users associated with the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -Note: This operation is atomic. +Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. +Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorganizationrole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-listOrgUsers/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole`, + URL: `/api/atlas/v2/orgs/{orgId}/users`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17630,21 +17504,61 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - }, - URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, - Required: true, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `username`, + Description: `Email address to filter users by. Not supported in deprecated versions.`, + Short: ``, + Required: false, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, }, { - Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, + Name: `orgMembershipStatus`, + Description: `Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ + { + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17653,12 +17567,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPost, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, { Version: shared_api.NewStableVersion(2025, 2, 19), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -17666,10 +17587,10 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `removeOrganizationUser`, + OperationID: `removeGroupUser`, ShortOperationID: ``, Aliases: nil, - Description: `Removes one MongoDB Cloud user in the specified organization. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Removes one MongoDB Cloud user from the specified project. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -17677,11 +17598,11 @@ Note: This resource cannot be used to remove pending users invited via the depre Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorganizationuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeGroupUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}`, + URL: `/api/atlas/v2/groups/{groupId}/users/{userId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17706,18 +17627,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, + Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17746,7 +17671,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `removeProjectRole`, + OperationID: `removeGroupUserRole`, ShortOperationID: ``, Aliases: nil, Description: `Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -17754,9 +17679,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectrole. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupuserrole. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeProjectRole/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeGroupUserRole/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole`, QueryParameters: []shared_api.Parameter{ @@ -17820,22 +17745,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `removeProjectUser`, + OperationID: `removeOrgTeamUser`, ShortOperationID: ``, Aliases: nil, - Description: `Removes one MongoDB Cloud user from the specified project. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + Description: `Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. +Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorgteamuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeProjectUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeOrgTeamUser/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/users/{userId}`, + URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17860,22 +17782,91 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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. + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `teamId`, + Description: `Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2025, 2, 19), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `removeOrgUser`, + ShortOperationID: ``, + Aliases: nil, + Description: `Removes one MongoDB Cloud user in the specified organization. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -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, +Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + + +Note: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorguser. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeOrgUser/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}`, + 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: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, + Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17904,19 +17895,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `removeUserFromTeam`, - ShortOperationID: ``, + OperationID: `removeOrgUserRole`, + ShortOperationID: `removeOrgRole`, Aliases: nil, - Description: `Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. +Note: This operation is atomic. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeuserfromteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam/`, +Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorguserrole. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-removeOrgUserRole/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser`, + URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -17951,8 +17945,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `teamId`, - Description: `Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.`, + Name: `userId`, + Description: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -17974,7 +17968,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganizationUser`, + OperationID: `updateOrgUser`, ShortOperationID: ``, Aliases: nil, Description: `Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -17985,9 +17979,9 @@ Note: Only include the fields you wish to update in the request body. Supplying Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorguser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-mongoDbCloudUsers-updateOrgUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}`, QueryParameters: []shared_api.Parameter{ @@ -18053,16 +18047,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Returns database deployment monitoring and logging data.`, Commands: []shared_api.Command{ { - OperationID: `getAtlasProcess`, - ShortOperationID: ``, + OperationID: `downloadGroupClusterLog`, + ShortOperationID: `downloadClusterLog`, Aliases: nil, - Description: `Returns the processes for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getatlasprocess. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusterlog. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getAtlasProcess/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-downloadGroupClusterLog/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -18075,13 +18069,23 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `endDate`, + Description: `Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, + }, + }, + { + Name: `startDate`, + Description: `Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, }, }, }, @@ -18101,8 +18105,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `processId`, - Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Name: `hostName`, + Description: `Human-readable label that identifies the host that stores the log files that you want to download.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `logName`, + Description: `Human-readable label that identifies the log file that you want to return. To return audit logs, enable Database Auditing for the specified project.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18118,36 +18132,73 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: ``, ResponseContentTypes: []string{ - `json`, + `gzip`, + }, + }, + { + Version: shared_api.NewStableVersion(2023, 2, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `gzip`, }, }, }, }, { - OperationID: `getDatabase`, - ShortOperationID: ``, + OperationID: `getGroupHostFtsMetricIndexMeasurements`, + ShortOperationID: `getIndexMeasurements`, Aliases: nil, - Description: `Returns one database running on the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabase. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouphostftsmetricindexmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getDatabase/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupHostFtsMetricIndexMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}`, + URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements`, 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.`, + Name: `granularity`, + Description: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `period`, + Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `string`, }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `start`, + Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `end`, + Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + 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{ @@ -18155,25 +18206,41 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `metrics`, + Description: `List that contains the measurements that MongoDB Atlas reports for the associated data series.`, + Short: ``, + Required: true, + 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, + Name: `processId`, + Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `indexName`, + Description: `Human-readable label that identifies the index.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `databaseName`, - Description: `Human-readable label that identifies the database that the specified MongoDB process serves.`, + Description: `Human-readable label that identifies the database.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18182,8 +18249,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `processId`, - Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Name: `collectionName`, + Description: `Human-readable label that identifies the collection.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18191,6 +18258,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, + { + 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`}, + }, }, Verb: http.MethodGet, }, @@ -18205,16 +18286,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getDatabaseMeasurements`, + OperationID: `getGroupProcess`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns the processes for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getdatabasemeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocess. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcess/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -18236,19 +18317,25 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + }, + URLParameters: []shared_api.Parameter{ { - Name: `m`, - Description: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, - Short: ``, - Required: false, + 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: true, + IsArray: false, Type: `string`, }, + Aliases: []string{`projectId`}, }, { - Name: `granularity`, - Description: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + Name: `processId`, + Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18256,34 +18343,49 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `period`, - Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, - Short: ``, - Required: false, - 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: `getGroupProcessDatabase`, + ShortOperationID: `getDatabase`, + Aliases: nil, + Description: `Returns one database running on the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdatabase. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcessDatabase/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}`, + QueryParameters: []shared_api.Parameter{ { - Name: `start`, - Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + 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: `string`, + Type: `bool`, }, }, { - Name: `end`, - Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + 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: `string`, + Type: `bool`, }, }, }, @@ -18336,33 +18438,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getDiskMeasurements`, - ShortOperationID: ``, + OperationID: `getGroupProcessDatabaseMeasurements`, + ShortOperationID: `getDatabaseMeasurements`, Aliases: nil, - Description: `Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following: - - - -Throughput of I/O operations for the disk partition used for the MongoDB process - - -Percentage of time during which requests the partition issued and serviced - - -Latency per operation type of the disk partition used for the MongoDB process - - -Amount of free and used disk space on the disk partition used for the MongoDB process - - - -To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting 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-getdiskmeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdatabasemeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getDiskMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcessDatabaseMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -18450,6 +18535,63 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `databaseName`, + Description: `Human-readable label that identifies the database that the specified MongoDB process serves.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `processId`, + Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + 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: `getGroupProcessDisk`, + ShortOperationID: `getProcessDisk`, + Aliases: nil, + Description: `Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessdisk. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcessDisk/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}`, + 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`, + }, + }, + }, + URLParameters: []shared_api.Parameter{ { Name: `partitionName`, Description: `Human-readable label of the disk or partition to which the measurements apply.`, @@ -18460,6 +18602,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, + { + 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: `processId`, Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, @@ -18484,16 +18640,33 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getHostLogs`, - ShortOperationID: ``, + OperationID: `getGroupProcessDiskMeasurements`, + ShortOperationID: `getProcessDiskMeasurements`, Aliases: nil, - Description: `Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". + Description: `Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following: + + + +Throughput of I/O operations for the disk partition used for the MongoDB process -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-gethostlogs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getHostLogs/`, +Percentage of time during which requests the partition issued and serviced + + +Latency per operation type of the disk partition used for the MongoDB process + + +Amount of free and used disk space on the disk partition used for the MongoDB process + + + +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-getgroupprocessdiskmeasurements. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcessDiskMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz`, + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -18506,23 +18679,63 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `endDate`, - Description: `Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.`, + 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: `int`, + Type: `bool`, }, }, { - Name: `startDate`, - Description: `Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.`, + Name: `m`, + Description: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, Short: ``, Required: false, + Type: shared_api.ParameterType{ + IsArray: true, + Type: `string`, + }, + }, + { + Name: `granularity`, + Description: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, - Type: `int`, + Type: `string`, + }, + }, + { + Name: `period`, + Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `start`, + Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `end`, + Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, }, }, }, @@ -18542,8 +18755,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `hostName`, - Description: `Human-readable label that identifies the host that stores the log files that you want to download.`, + Name: `partitionName`, + Description: `Human-readable label of the disk or partition to which the measurements apply.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18552,8 +18765,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `logName`, - Description: `Human-readable label that identifies the log file that you want to return. To return audit logs, enable Database Auditing for the specified project.`, + Name: `processId`, + Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -18569,21 +18782,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: ``, ResponseContentTypes: []string{ - `gzip`, - }, - }, - { - Version: shared_api.NewStableVersion(2023, 2, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `gzip`, + `json`, }, }, }, }, { - OperationID: `getHostMeasurements`, - ShortOperationID: ``, + OperationID: `getGroupProcessMeasurements`, + ShortOperationID: `getProcessMeasurements`, Aliases: nil, Description: `Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following: @@ -18607,9 +18813,9 @@ Measurements for the host, such as CPU usage or number of I/O operations 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-gethostmeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprocessmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getHostMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getGroupProcessMeasurements/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements`, QueryParameters: []shared_api.Parameter{ @@ -18723,16 +18929,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getIndexMetrics`, - ShortOperationID: ``, + OperationID: `listGroupHostFtsMetricIndexMeasurements`, + ShortOperationID: `listIndexMeasurements`, Aliases: nil, - Description: `Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. + Description: `Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getindexmetrics. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetricindexmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getIndexMetrics/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupHostFtsMetricIndexMeasurements/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements`, QueryParameters: []shared_api.Parameter{ { Name: `granularity`, @@ -18806,16 +19012,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `indexName`, - Description: `Human-readable label that identifies the index.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, { Name: `databaseName`, Description: `Human-readable label that identifies the database.`, @@ -18864,14 +19060,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getMeasurements`, - ShortOperationID: ``, + OperationID: `listGroupHostFtsMetricMeasurements`, + ShortOperationID: `listMeasurements`, Aliases: nil, Description: `Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmeasurements. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetricmeasurements. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-getMeasurements/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupHostFtsMetricMeasurements/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements`, QueryParameters: []shared_api.Parameter{ @@ -18975,16 +19171,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listAtlasProcesses`, - ShortOperationID: ``, + OperationID: `listGroupHostFtsMetrics`, + ShortOperationID: `listHostFtsMetrics`, Aliases: nil, - Description: `Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listatlasprocesses. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetrics. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listAtlasProcesses/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupHostFtsMetrics/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes`, + URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -18996,48 +19192,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + }, + URLParameters: []shared_api.Parameter{ { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `processId`, + Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, Short: ``, - Required: false, + Required: true, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + 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. @@ -19066,14 +19232,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDatabases`, - ShortOperationID: ``, + OperationID: `listGroupProcessDatabases`, + ShortOperationID: `listDatabases`, Aliases: nil, Description: `Returns the list of databases running on the specified host for the specified project. M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabases. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessdatabases. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listDatabases/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupProcessDatabases/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/databases`, QueryParameters: []shared_api.Parameter{ @@ -19167,85 +19333,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDiskMeasurements`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskmeasurements. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listDiskMeasurements/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}`, - 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`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `partitionName`, - Description: `Human-readable label of the disk or partition to which the measurements apply.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - 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: `processId`, - Description: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - 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: `listDiskPartitions`, - ShortOperationID: ``, + OperationID: `listGroupProcessDisks`, + ShortOperationID: `listProcessDisks`, Aliases: nil, Description: `Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdiskpartitions. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessdisks. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listDiskPartitions/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupProcessDisks/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/disks`, QueryParameters: []shared_api.Parameter{ @@ -19339,57 +19434,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listIndexMetrics`, + OperationID: `listGroupProcesses`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. + Description: `Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting 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-listindexmetrics. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocesses. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listIndexMetrics/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listGroupProcesses/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements`, + URL: `/api/atlas/v2/groups/{groupId}/processes`, QueryParameters: []shared_api.Parameter{ - { - Name: `granularity`, - Description: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `period`, - Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `start`, - Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `end`, - Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - 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.`, @@ -19401,89 +19456,38 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `metrics`, - Description: `List that contains the measurements that MongoDB Atlas reports for the associated data series.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: true, - Type: `string`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `processId`, - Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, - Required: true, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `bool`, }, }, { - Name: `databaseName`, - Description: `Human-readable label that identifies the database.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, - Required: true, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `int`, }, }, { - Name: `collectionName`, - Description: `Human-readable label that identifies the collection.`, + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, Short: ``, - Required: true, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `int`, }, }, { - 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`}, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `listMetricTypes`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listmetrictypes. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-monitoringAndLogs-listMetricTypes/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics`, - 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.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -19493,16 +19497,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, URLParameters: []shared_api.Parameter{ - { - Name: `processId`, - Description: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, { 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. @@ -19538,16 +19532,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.`, Commands: []shared_api.Command{ { - OperationID: `createPeeringConnection`, + OperationID: `createGroupContainer`, ShortOperationID: ``, Aliases: nil, - Description: `Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. + Description: `Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcontainer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-createPeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-createGroupContainer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/peers`, + URL: `/api/atlas/v2/groups/{groupId}/containers`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19599,16 +19593,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createPeeringContainer`, + OperationID: `createGroupPeer`, ShortOperationID: ``, Aliases: nil, - Description: `Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpeeringcontainer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategrouppeer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-createPeeringContainer/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-createGroupPeer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/containers`, + URL: `/api/atlas/v2/groups/{groupId}/peers`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19660,16 +19654,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deletePeeringConnection`, + OperationID: `deleteGroupContainer`, ShortOperationID: ``, Aliases: nil, - Description: `Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupcontainer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-deletePeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-deleteGroupContainer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, + URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19708,8 +19702,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `peerId`, - Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.`, + Name: `containerId`, + Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -19731,16 +19725,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deletePeeringContainer`, + OperationID: `deleteGroupPeer`, ShortOperationID: ``, Aliases: nil, - Description: `Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepeeringcontainer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegrouppeer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-deletePeeringContainer/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-deleteGroupPeer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, + URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19779,8 +19773,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `containerId`, - Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, + Name: `peerId`, + Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -19802,14 +19796,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `disablePeering`, - ShortOperationID: ``, + OperationID: `disableGroupPrivateIpModePeering`, + ShortOperationID: `disablePeering`, Aliases: nil, Description: `Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablepeering. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupprivateipmodepeering. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-disablePeering/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-disableGroupPrivateIpModePeering/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateIpMode`, QueryParameters: []shared_api.Parameter{ @@ -19863,16 +19857,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getPeeringConnection`, + OperationID: `getGroupContainer`, ShortOperationID: ``, Aliases: nil, - Description: `Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcontainer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-getPeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-getGroupContainer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, + URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19911,8 +19905,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `peerId`, - Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.`, + Name: `containerId`, + Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -19934,16 +19928,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getPeeringContainer`, + OperationID: `getGroupPeer`, ShortOperationID: ``, Aliases: nil, - Description: `Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpeeringcontainer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouppeer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-getPeeringContainer/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-getGroupPeer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, + URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -19982,8 +19976,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `containerId`, - Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.`, + Name: `peerId`, + Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -20005,16 +19999,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listPeeringConnections`, + OperationID: `listGroupContainerAll`, ShortOperationID: ``, Aliases: nil, - Description: `Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcontainerall. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listPeeringConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listGroupContainerAll/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/peers`, + URL: `/api/atlas/v2/groups/{groupId}/containers/all`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -20066,16 +20060,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `providerName`, - Description: `Cloud service provider to use for this VPC peering connection.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -20106,14 +20090,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listPeeringContainerByCloudProvider`, + OperationID: `listGroupContainers`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainerbycloudprovider. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupcontainers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listGroupContainers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/containers`, QueryParameters: []shared_api.Parameter{ @@ -20207,16 +20191,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listPeeringContainers`, + OperationID: `listGroupPeers`, ShortOperationID: ``, Aliases: nil, - Description: `Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listpeeringcontainers. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouppeers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listPeeringContainers/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-listGroupPeers/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/containers/all`, + URL: `/api/atlas/v2/groups/{groupId}/peers`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -20268,6 +20252,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `providerName`, + Description: `Cloud service provider to use for this VPC peering connection.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, URLParameters: []shared_api.Parameter{ { @@ -20298,16 +20292,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updatePeeringConnection`, + OperationID: `updateGroupContainer`, ShortOperationID: ``, Aliases: nil, - Description: `Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcontainer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-updatePeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-updateGroupContainer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, + URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -20346,8 +20340,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `peerId`, - Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.`, + Name: `containerId`, + Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -20369,16 +20363,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updatePeeringContainer`, + OperationID: `updateGroupPeer`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepeeringcontainer. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategrouppeer. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-updatePeeringContainer/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-updateGroupPeer/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/containers/{containerId}`, + URL: `/api/atlas/v2/groups/{groupId}/peers/{peerId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -20417,8 +20411,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `containerId`, - Description: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, + Name: `peerId`, + Description: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -20440,14 +20434,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `verifyConnectViaPeeringOnlyModeForOneProject`, - ShortOperationID: ``, + OperationID: `verifyGroupPrivateIpMode`, + ShortOperationID: `verifyPrivateIpMode`, Aliases: nil, Description: `Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifyconnectviapeeringonlymodeforoneproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-verifygroupprivateipmode. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-verifyGroupPrivateIpMode/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateIpMode`, QueryParameters: []shared_api.Parameter{ @@ -20507,14 +20501,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, or removes an online archive.`, Commands: []shared_api.Command{ { - OperationID: `createOnlineArchive`, - ShortOperationID: ``, + OperationID: `createGroupClusterOnlineArchive`, + ShortOperationID: `createOnlineArchive`, Aliases: nil, Description: `Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusteronlinearchive. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-createOnlineArchive/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-createGroupClusterOnlineArchive/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives`, QueryParameters: []shared_api.Parameter{ @@ -20578,10 +20572,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getOnlineArchive`, + OperationID: `createGroupClusterOnlineArchive`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ - `archiveId`: `body:$.id`, `clusterName`: `input:clusterName`, `groupId`: `input:groupId`, }, @@ -20601,14 +20594,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteOnlineArchive`, - ShortOperationID: ``, + OperationID: `deleteGroupClusterOnlineArchive`, + ShortOperationID: `deleteOnlineArchive`, Aliases: nil, Description: `Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupclusteronlinearchive. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-deleteOnlineArchive/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-deleteGroupClusterOnlineArchive/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}`, QueryParameters: []shared_api.Parameter{ @@ -20682,7 +20675,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getOnlineArchive`, + OperationID: `deleteGroupClusterOnlineArchive`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `archiveId`: `input:archiveId`, @@ -20697,14 +20690,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `downloadOnlineArchiveQueryLogs`, - ShortOperationID: ``, + OperationID: `downloadGroupClusterOnlineArchiveQueryLogs`, + ShortOperationID: `downloadQueryLogs`, Aliases: nil, Description: `Downloads query logs for the specified online archive. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadonlinearchivequerylogs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusteronlinearchivequerylogs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-downloadGroupClusterOnlineArchiveQueryLogs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz`, QueryParameters: []shared_api.Parameter{ @@ -20788,14 +20781,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getOnlineArchive`, - ShortOperationID: ``, + OperationID: `getGroupClusterOnlineArchive`, + ShortOperationID: `getOnlineArchive`, Aliases: nil, Description: `Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusteronlinearchive. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-getOnlineArchive/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-getGroupClusterOnlineArchive/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}`, QueryParameters: []shared_api.Parameter{ @@ -20869,14 +20862,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listOnlineArchives`, - ShortOperationID: ``, + OperationID: `listGroupClusterOnlineArchives`, + ShortOperationID: `listOnlineArchives`, Aliases: nil, Description: `Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listonlinearchives. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusteronlinearchives. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-listOnlineArchives/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-listGroupClusterOnlineArchives/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives`, QueryParameters: []shared_api.Parameter{ @@ -20970,14 +20963,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateOnlineArchive`, - ShortOperationID: ``, + OperationID: `updateGroupClusterOnlineArchive`, + ShortOperationID: `updateOnlineArchive`, Aliases: nil, Description: `Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateonlinearchive. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupclusteronlinearchive. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-updateOnlineArchive/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-onlineArchive-updateGroupClusterOnlineArchive/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}`, QueryParameters: []shared_api.Parameter{ @@ -21051,7 +21044,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getOnlineArchive`, + OperationID: `updateGroupClusterOnlineArchive`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `archiveId`: `input:archiveId`, @@ -21080,14 +21073,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, and edits organizational units in MongoDB Cloud.`, Commands: []shared_api.Command{ { - OperationID: `createOrganization`, + OperationID: `createOrg`, ShortOperationID: ``, Aliases: nil, Description: `Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganization. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorg. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-createOrganization/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-createOrg/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs`, QueryParameters: []shared_api.Parameter{ @@ -21126,7 +21119,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createOrganizationInvitation`, + OperationID: `createOrgInvite`, ShortOperationID: ``, Aliases: nil, Description: `Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -21134,9 +21127,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganizationinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorginvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-createOrganizationInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-createOrgInvite/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/invites`, QueryParameters: []shared_api.Parameter{ @@ -21186,7 +21179,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteOrganization`, + OperationID: `deleteOrg`, ShortOperationID: ``, Aliases: nil, Description: `Removes one specified organization. MongoDB Cloud imposes the following limits on this resource: @@ -21199,9 +21192,9 @@ Organizations with active projects cannot be removed. All projects in the organization must be removed before you can remove the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorganization. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorg. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-deleteOrganization/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-deleteOrg/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}`, QueryParameters: []shared_api.Parameter{ @@ -21241,7 +21234,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteOrganizationInvitation`, + OperationID: `deleteOrgInvite`, ShortOperationID: ``, Aliases: nil, Description: `Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -21249,9 +21242,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Note: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorganizationinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorginvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-deleteOrganizationInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-deleteOrgInvite/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ @@ -21311,14 +21304,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getOrganization`, + OperationID: `getOrg`, ShortOperationID: ``, Aliases: nil, Description: `Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganization. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorg. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrganization/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrg/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}`, QueryParameters: []shared_api.Parameter{ @@ -21368,19 +21361,33 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getOrganizationInvitation`, + OperationID: `getOrgGroups`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the details of one pending invitation to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: -Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationinvitation. +Isolate different environments, such as development, test, or production environments, from each other. + + +Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments. + + +Maintain separate cluster security configurations. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrganizationInvitation/`, + +Create different alert 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-getorggroups. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrgGroups/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invites/{invitationId}`, + URL: `/api/atlas/v2/orgs/{orgId}/groups`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21392,21 +21399,61 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - }, - URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, - Required: true, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + 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: `name`, + Description: `Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.`, + Short: ``, + Required: false, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, }, + }, + URLParameters: []shared_api.Parameter{ { - Name: `invitationId`, - Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -21428,16 +21475,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getOrganizationSettings`, + OperationID: `getOrgInvite`, ShortOperationID: ``, 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 Member role. + Description: `Returns the details of one pending invitation to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + + +Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. -This command 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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrganizationSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrgInvite/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/settings`, + URL: `/api/atlas/v2/orgs/{orgId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21449,21 +21499,21 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + }, + URLParameters: []shared_api.Parameter{ { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, - Required: false, + Required: true, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `string`, }, }, - }, - URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `invitationId`, + Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -21485,19 +21535,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizationInvitations`, + OperationID: `getOrgSettings`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all pending invitations to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - - -Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. + 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-listorganizationinvitations. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-listOrganizationInvitations/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-getOrgSettings/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invites`, + URL: `/api/atlas/v2/orgs/{orgId}/settings`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21519,16 +21566,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `username`, - Description: `Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -21555,33 +21592,19 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizationProjects`, + OperationID: `listOrgInvites`, ShortOperationID: ``, Aliases: nil, - Description: `Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: - - - -Isolate different environments, such as development, test, or production environments, from each other. - - -Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments. - - -Maintain separate cluster security configurations. - - -Create different alert settings. - + Description: `Returns all pending invitations to the specified organization. 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. +Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizationprojects. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorginvites. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-listOrganizationProjects/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-listOrgInvites/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/groups`, + URL: `/api/atlas/v2/orgs/{orgId}/invites`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21593,36 +21616,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, { Name: `pretty`, Description: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -21634,8 +21627,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `name`, - Description: `Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.`, + Name: `username`, + Description: `Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -21669,14 +21662,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizations`, + OperationID: `listOrgs`, ShortOperationID: ``, Aliases: nil, Description: `Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizations. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-listOrganizations/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-listOrgs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs`, QueryParameters: []shared_api.Parameter{ @@ -21755,14 +21748,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganization`, + OperationID: `updateOrg`, ShortOperationID: ``, Aliases: nil, Description: `Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganization. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorg. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrganization/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrg/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}`, QueryParameters: []shared_api.Parameter{ @@ -21812,16 +21805,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganizationInvitation`, + OperationID: `updateOrgInviteById`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. + Description: `Updates the details of one pending invitation, identified by its unique ID, to the specified organization. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorginvitebyid. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrganizationInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrgInviteById/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invites`, + URL: `/api/atlas/v2/orgs/{orgId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21855,6 +21848,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `invitationId`, + Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPatch, }, @@ -21869,16 +21872,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganizationInvitationById`, + OperationID: `updateOrgInvites`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the details of one pending invitation, identified by its unique ID, to the specified organization. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. + Description: `Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationinvitationbyid. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorginvites. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrganizationInvitationById/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrgInvites/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/invites/{invitationId}`, + URL: `/api/atlas/v2/orgs/{orgId}/invites`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -21912,16 +21915,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `invitationId`, - Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodPatch, }, @@ -21936,20 +21929,20 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganizationRoles`, + OperationID: `updateOrgSettings`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. + Description: `Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrganizationRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrgSettings/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}/roles`, + URL: `/api/atlas/v2/orgs/{orgId}/settings`, QueryParameters: []shared_api.Parameter{ { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + 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{ @@ -21958,8 +21951,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - 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.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -21979,18 +21972,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the user to modify.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPut, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { @@ -22003,20 +21986,20 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateOrganizationSettings`, + OperationID: `updateOrgUserRoles`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. + Description: `Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorganizationsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorguserroles. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrganizationSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-organizations-updateOrgUserRoles/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/settings`, + URL: `/api/atlas/v2/orgs/{orgId}/users/{userId}/roles`, 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.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -22025,8 +22008,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + 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{ @@ -22046,8 +22029,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `userId`, + Description: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPatch, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { @@ -22066,14 +22059,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.`, Commands: []shared_api.Command{ { - OperationID: `disableSlowOperationThresholding`, - ShortOperationID: ``, + OperationID: `disableGroupManagedSlowMs`, + ShortOperationID: `disableManagedSlowMs`, Aliases: nil, Description: `Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disableslowoperationthresholding. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupmanagedslowms. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-disableGroupManagedSlowMs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/managedSlowMs/disable`, QueryParameters: []shared_api.Parameter{ @@ -22127,14 +22120,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `enableSlowOperationThresholding`, - ShortOperationID: ``, + OperationID: `enableGroupManagedSlowMs`, + ShortOperationID: `enableManagedSlowMs`, Aliases: nil, Description: `Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-enableslowoperationthresholding. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-enablegroupmanagedslowms. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-enableGroupManagedSlowMs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/managedSlowMs/enable`, QueryParameters: []shared_api.Parameter{ @@ -22188,14 +22181,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getManagedSlowMs`, - ShortOperationID: ``, + OperationID: `getGroupManagedSlowMs`, + ShortOperationID: `getManagedSlowMs`, Aliases: nil, Description: `Get whether the Managed Slow MS feature is enabled. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getmanagedslowms. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupmanagedslowms. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-getManagedSlowMs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-getGroupManagedSlowMs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/managedSlowMs`, QueryParameters: []shared_api.Parameter{ @@ -22249,14 +22242,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServerlessAutoIndexing`, - ShortOperationID: ``, + OperationID: `getGroupServerlessPerformanceAdvisorAutoIndexing`, + ShortOperationID: `getServerlessAutoIndexing`, Aliases: nil, Description: `Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessautoindexing. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessperformanceadvisorautoindexing. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-getGroupServerlessPerformanceAdvisorAutoIndexing/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing`, QueryParameters: []shared_api.Parameter{ @@ -22320,14 +22313,114 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listClusterSuggestedIndexes`, - ShortOperationID: ``, + OperationID: `listGroupClusterPerformanceAdvisorDropIndexSuggestions`, + ShortOperationID: `listDropIndexSuggestions`, + Aliases: nil, + Description: `Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting 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-listgroupclusterperformanceadvisordropindexsuggestions. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupClusterPerformanceAdvisorDropIndexSuggestions/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions`, + QueryParameters: []shared_api.Parameter{}, + 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(2024, 8, 5), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `listGroupClusterPerformanceAdvisorSchemaAdvice`, + ShortOperationID: `listSchemaAdvice`, + Aliases: nil, + Description: `Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting 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-listgroupclusterperformanceadvisorschemaadvice. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupClusterPerformanceAdvisorSchemaAdvice/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice`, + QueryParameters: []shared_api.Parameter{}, + 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(2024, 8, 5), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `listGroupClusterPerformanceAdvisorSuggestedIndexes`, + ShortOperationID: `listClusterSuggestedIndexes`, Aliases: nil, Description: `Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersuggestedindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisorsuggestedindexes. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupClusterPerformanceAdvisorSuggestedIndexes/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes`, QueryParameters: []shared_api.Parameter{ @@ -22425,67 +22518,72 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDropIndexes`, - ShortOperationID: ``, + OperationID: `listGroupProcessPerformanceAdvisorNamespaces`, + ShortOperationID: `listPerformanceAdvisorNamespaces`, Aliases: nil, - Description: `Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdropindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisornamespaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listDropIndexes/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupProcessPerformanceAdvisorNamespaces/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions`, - QueryParameters: []shared_api.Parameter{}, - URLParameters: []shared_api.Parameter{ + URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces`, + QueryParameters: []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, + 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: `string`, + Type: `bool`, }, - Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, - Required: true, + Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `string`, + Type: `bool`, }, }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, + { + Name: `duration`, + Description: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. + + + +If you don't specify the since parameter, the endpoint returns data covering the duration before the current time. + + +If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, }, - }, - }, - }, - { - OperationID: `listSchemaAdvice`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + { + Name: `since`, + Description: `Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listschemaadvice. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listSchemaAdvice/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice`, - QueryParameters: []shared_api.Parameter{}, + +If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time. + + +If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + }, URLParameters: []shared_api.Parameter{ { Name: `groupId`, @@ -22502,8 +22600,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, + Name: `processId`, + Description: `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.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -22516,7 +22614,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 8, 5), + Version: shared_api.NewStableVersion(2023, 1, 1), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -22525,14 +22623,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listSlowQueries`, - ShortOperationID: ``, + OperationID: `listGroupProcessPerformanceAdvisorSlowQueryLogs`, + ShortOperationID: `listSlowQueryLogs`, Aliases: nil, Description: `Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowqueries. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisorslowquerylogs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listSlowQueries/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupProcessPerformanceAdvisorSlowQueryLogs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs`, QueryParameters: []shared_api.Parameter{ @@ -22680,119 +22778,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listSlowQueryNamespaces`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listslowquerynamespaces. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces`, - 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: `duration`, - Description: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - - - -If you don't specify the since parameter, the endpoint returns data covering the duration before the current time. - - -If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `since`, - Description: `Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - - - -If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time. - - -If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - }, - 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: `processId`, - Description: `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.`, - 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: `listSuggestedIndexes`, - ShortOperationID: ``, + OperationID: `listGroupProcessPerformanceAdvisorSuggestedIndexes`, + ShortOperationID: `listSuggestedIndexes`, Aliases: nil, Description: `Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsuggestedindexes. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprocessperformanceadvisorsuggestedindexes. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listSuggestedIndexes/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-listGroupProcessPerformanceAdvisorSuggestedIndexes/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes`, QueryParameters: []shared_api.Parameter{ @@ -22950,14 +22943,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `setServerlessAutoIndexing`, - ShortOperationID: ``, + OperationID: `setGroupServerlessPerformanceAdvisorAutoIndexing`, + ShortOperationID: `setServerlessAutoIndexing`, Aliases: nil, Description: `Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setserverlessautoindexing. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgroupserverlessperformanceadvisorautoindexing. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-performanceAdvisor-setGroupServerlessPerformanceAdvisorAutoIndexing/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing`, QueryParameters: []shared_api.Parameter{ @@ -23027,14 +23020,93 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes private endpoint services.`, Commands: []shared_api.Command{ { - OperationID: `createPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `createGroupPrivateEndpointEndpointService`, + ShortOperationID: `createPrivateEndpointService`, + Aliases: nil, + Description: `Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointendpointservice. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-createGroupPrivateEndpointEndpointService/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService`, + 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`}, + }, + }, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `createGroupPrivateEndpointEndpointService`, + Version: shared_api.NewStableVersion(2023, 1, 1), + Params: map[string]string{ + `groupId`: `input:groupId`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.status`, + Values: []string{ + `WAITING_FOR_USER`, + `FAILED`, + }, + }, + }, + }, + }, + { + OperationID: `createGroupPrivateEndpointEndpointServiceEndpoint`, + ShortOperationID: `createPrivateEndpoint`, Aliases: nil, Description: `Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointendpointserviceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-createPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-createGroupPrivateEndpointEndpointServiceEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint`, QueryParameters: []shared_api.Parameter{ @@ -23108,16 +23180,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createPrivateEndpointService`, - ShortOperationID: ``, + OperationID: `deleteGroupPrivateEndpointEndpointService`, + ShortOperationID: `deletePrivateEndpointService`, Aliases: nil, - Description: `Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointendpointservice. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-createPrivateEndpointService/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-deleteGroupPrivateEndpointEndpointService/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23155,13 +23227,33 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `cloudProvider`, + Description: `Cloud service provider that manages this private endpoint service.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `endpointServiceId`, + Description: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -23169,7 +23261,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getPrivateEndpointService`, + OperationID: `deleteGroupPrivateEndpointEndpointService`, Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `cloudProvider`: `body:$.cloudProvider`, @@ -23178,25 +23270,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.status`, - Values: []string{ - `WAITING_FOR_USER`, - `FAILED`, - }, - }, + HTTPCode: 404, //nolint + Match: nil, }, }, }, { - OperationID: `deletePrivateEndpoint`, - ShortOperationID: ``, + OperationID: `deleteGroupPrivateEndpointEndpointServiceEndpoint`, + ShortOperationID: `deletePrivateEndpoint`, Aliases: nil, Description: `Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointendpointserviceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-deletePrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-deleteGroupPrivateEndpointEndpointServiceEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -23280,14 +23367,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deletePrivateEndpointService`, - ShortOperationID: ``, + OperationID: `getGroupPrivateEndpointEndpointService`, + ShortOperationID: `getPrivateEndpointService`, Aliases: nil, - Description: `Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting 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-deleteprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointendpointservice. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-deletePrivateEndpointService/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getGroupPrivateEndpointEndpointService/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}`, QueryParameters: []shared_api.Parameter{ @@ -23339,7 +23426,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `endpointServiceId`, - Description: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.`, + Description: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -23348,7 +23435,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -23359,31 +23446,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getPrivateEndpointService`, - Version: shared_api.NewStableVersion(2023, 1, 1), - Params: map[string]string{ - `cloudProvider`: `body:$.cloudProvider`, - `endpointServiceId`: `body:$.id`, - `groupId`: `input:groupId`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - HTTPCode: 404, //nolint - Match: nil, - }, - }, }, { - OperationID: `getPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `getGroupPrivateEndpointEndpointServiceEndpoint`, + ShortOperationID: `getPrivateEndpoint`, Aliases: nil, Description: `Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointendpointserviceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getGroupPrivateEndpointEndpointServiceEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -23467,16 +23539,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getPrivateEndpointService`, - ShortOperationID: ``, + OperationID: `getGroupPrivateEndpointRegionalMode`, + ShortOperationID: `getRegionalEndpointMode`, Aliases: nil, - Description: `Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivateendpointservice. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointregionalmode. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getPrivateEndpointService/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getGroupPrivateEndpointRegionalMode/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23514,26 +23586,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `cloudProvider`, - Description: `Cloud service provider that manages this private endpoint service.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `endpointServiceId`, - Description: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -23548,16 +23600,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getRegionalizedPrivateEndpointSetting`, - ShortOperationID: ``, + OperationID: `listGroupPrivateEndpointEndpointService`, + ShortOperationID: `listPrivateEndpointService`, Aliases: nil, - Description: `Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getregionalizedprivateendpointsetting. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivateendpointendpointservice. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-listGroupPrivateEndpointEndpointService/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23595,6 +23647,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `cloudProvider`, + Description: `Cloud service provider that manages this private endpoint service.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -23609,16 +23671,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listPrivateEndpointServices`, - ShortOperationID: ``, + OperationID: `toggleGroupPrivateEndpointRegionalMode`, + ShortOperationID: `toggleRegionalEndpointMode`, Aliases: nil, - Description: `Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivateendpointservices. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupprivateendpointregionalmode. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-listPrivateEndpointServices/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-toggleGroupPrivateEndpointRegionalMode/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23656,40 +23718,36 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `cloudProvider`, - Description: `Cloud service provider that manages this private endpoint service.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Programmatic API Keys`, + Description: `Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.`, + Commands: []shared_api.Command{ { - OperationID: `toggleRegionalizedPrivateEndpointSetting`, + OperationID: `addGroupApiKey`, ShortOperationID: ``, Aliases: nil, - Description: `Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. + Description: `Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-toggleregionalizedprivateendpointsetting. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-addGroupApiKey/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode`, + URL: `/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23727,8 +23785,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `apiUserId`, + Description: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPatch, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -23740,23 +23808,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - }, - }, - { - Name: `Programmatic API Keys`, - Description: `Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.`, - Commands: []shared_api.Command{ { - OperationID: `addProjectApiKey`, + OperationID: `createGroupApiKey`, ShortOperationID: ``, Aliases: nil, - Description: `Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-addProjectApiKey/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createGroupApiKey/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}`, + URL: `/api/atlas/v2/groups/{groupId}/apiKeys`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -23794,16 +23856,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `apiUserId`, - Description: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodPost, }, @@ -23818,14 +23870,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createApiKey`, + OperationID: `createOrgApiKey`, ShortOperationID: ``, Aliases: nil, Description: `Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createApiKey/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createOrgApiKey/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys`, QueryParameters: []shared_api.Parameter{ @@ -23875,14 +23927,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createApiKeyAccessList`, - ShortOperationID: ``, + OperationID: `createOrgApiKeyAccessListEntry`, + ShortOperationID: `createOrgAccessEntry`, Aliases: nil, Description: `Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikeyaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgapikeyaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createApiKeyAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createOrgApiKeyAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList`, QueryParameters: []shared_api.Parameter{ @@ -23972,75 +24024,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createProjectApiKey`, - ShortOperationID: ``, - Aliases: nil, - Description: `Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-createProjectApiKey/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/apiKeys`, - 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`}, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `deleteApiKey`, + OperationID: `deleteOrgApiKey`, ShortOperationID: ``, Aliases: nil, Description: `Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikey. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-deleteApiKey/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-deleteOrgApiKey/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}`, QueryParameters: []shared_api.Parameter{ @@ -24100,14 +24091,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteApiKeyAccessListEntry`, - ShortOperationID: ``, + OperationID: `deleteOrgApiKeyAccessListEntry`, + ShortOperationID: `deleteAccessEntry`, Aliases: nil, Description: `Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteapikeyaccesslistentry. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgapikeyaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-deleteOrgApiKeyAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}`, QueryParameters: []shared_api.Parameter{ @@ -24177,14 +24168,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getApiKey`, + OperationID: `getOrgApiKey`, ShortOperationID: ``, Aliases: nil, Description: `Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikey. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-getApiKey/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-getOrgApiKey/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}`, QueryParameters: []shared_api.Parameter{ @@ -24244,14 +24235,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getApiKeyAccessList`, - ShortOperationID: ``, + OperationID: `getOrgApiKeyAccessListEntry`, + ShortOperationID: `getOrgAccessEntry`, Aliases: nil, Description: `Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getapikeyaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikeyaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-getApiKeyAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-getOrgApiKeyAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}`, QueryParameters: []shared_api.Parameter{ @@ -24321,16 +24312,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listApiKeyAccessListsEntries`, + OperationID: `listGroupApiKeys`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + Description: `Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeyaccesslistsentries. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupapikeys. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listGroupApiKeys/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList`, + URL: `/api/atlas/v2/groups/{groupId}/apiKeys`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -24385,24 +24376,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `apiUserId`, - Description: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, - Short: ``, - Required: true, + 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`}, }, }, Verb: http.MethodGet, @@ -24418,16 +24403,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listApiKeys`, - ShortOperationID: ``, + OperationID: `listOrgApiKeyAccessListEntries`, + ShortOperationID: `listOrgAccessEntries`, Aliases: nil, - Description: `Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + Description: `Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listapikeys. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgapikeyaccesslistentries. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listApiKeys/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listOrgApiKeyAccessListEntries/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/apiKeys`, + URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -24491,6 +24476,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `apiUserId`, + Description: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -24505,16 +24500,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listProjectApiKeys`, + OperationID: `listOrgApiKeys`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting 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-listprojectapikeys. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgapikeys. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listProjectApiKeys/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-listOrgApiKeys/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/apiKeys`, + URL: `/api/atlas/v2/orgs/{orgId}/apiKeys`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -24569,18 +24564,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, }, Verb: http.MethodGet, @@ -24596,14 +24587,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `removeProjectApiKey`, + OperationID: `removeGroupApiKey`, ShortOperationID: ``, Aliases: nil, Description: `Removes one organization API key from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectapikey. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupapikey. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-removeProjectApiKey/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-removeGroupApiKey/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}`, QueryParameters: []shared_api.Parameter{ @@ -24630,89 +24621,22 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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: `apiUserId`, - Description: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodDelete, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `updateApiKey`, - ShortOperationID: ``, - Aliases: nil, - Description: `Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-updateApiKey/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}`, - 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: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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: `apiUserId`, - Description: `Unique 24-hexadecimal digit string that identifies this organization API key you want to update.`, + Description: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -24721,12 +24645,12 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -24734,14 +24658,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateApiKeyRoles`, - ShortOperationID: ``, + OperationID: `updateGroupApiKeyRoles`, + ShortOperationID: `updateApiKeyRoles`, Aliases: nil, Description: `Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikeyroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupapikeyroles. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-updateApiKeyRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-updateGroupApiKeyRoles/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}`, QueryParameters: []shared_api.Parameter{ @@ -24834,6 +24758,73 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, + { + OperationID: `updateOrgApiKey`, + ShortOperationID: ``, + Aliases: nil, + Description: `Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgapikey. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-programmaticApiKeys-updateOrgApiKey/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}`, + 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: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `apiUserId`, + Description: `Unique 24-hexadecimal digit string that identifies this organization API key you want to update.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPatch, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, }, }, { @@ -24841,14 +24832,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.`, Commands: []shared_api.Command{ { - OperationID: `createProjectIpAccessList`, - ShortOperationID: ``, + OperationID: `createGroupAccessListEntry`, + ShortOperationID: `createAccessListEntry`, Aliases: nil, Description: `Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectipaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-createProjectIpAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-createGroupAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/accessList`, QueryParameters: []shared_api.Parameter{ @@ -24932,14 +24923,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProjectIpAccessList`, - ShortOperationID: ``, + OperationID: `deleteGroupAccessListEntry`, + ShortOperationID: `deleteAccessListEntry`, Aliases: nil, Description: `Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectipaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-deleteGroupAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/accessList/{entryValue}`, QueryParameters: []shared_api.Parameter{ @@ -25013,16 +25004,16 @@ which protocol (like TCP or UDP) the connection uses.`, }, }, { - OperationID: `getProjectIpAccessListStatus`, - ShortOperationID: ``, + OperationID: `getGroupAccessListEntry`, + ShortOperationID: `getAccessListEntry`, Aliases: nil, - Description: `Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. + Description: `Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectipaccessliststatus. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-getGroupAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status`, + URL: `/api/atlas/v2/groups/{groupId}/accessList/{entryValue}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -25062,7 +25053,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `entryValue`, - Description: `Network address or cloud provider security construct that identifies which project access list entry to be verified.`, + Description: `Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F).`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -25084,16 +25075,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProjectIpList`, - ShortOperationID: ``, + OperationID: `getGroupAccessListStatus`, + ShortOperationID: `getAccessListStatus`, Aliases: nil, - Description: `Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. + Description: `Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectiplist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupaccessliststatus. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-getProjectIpList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-getGroupAccessListStatus/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/accessList/{entryValue}`, + URL: `/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -25133,7 +25124,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `entryValue`, - Description: `Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F).`, + Description: `Network address or cloud provider security construct that identifies which project access list entry to be verified.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -25155,14 +25146,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listProjectIpAccessLists`, - ShortOperationID: ``, + OperationID: `listGroupAccessListEntries`, + ShortOperationID: `listAccessListEntries`, Aliases: nil, Description: `Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectipaccesslists. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupaccesslistentries. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-listProjectIpAccessLists/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projectIpAccessList-listGroupAccessListEntries/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/accessList`, QueryParameters: []shared_api.Parameter{ @@ -25252,14 +25243,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, and edits collections of clusters and users in MongoDB Cloud.`, Commands: []shared_api.Command{ { - OperationID: `addUserToProject`, - ShortOperationID: ``, + OperationID: `addGroupAccessUser`, + ShortOperationID: `addGroupUser`, Aliases: nil, Description: `Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addusertoproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupaccessuser. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-addUserToProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-addGroupAccessUser/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/access`, QueryParameters: []shared_api.Parameter{ @@ -25314,14 +25305,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createProject`, + OperationID: `createGroup`, ShortOperationID: ``, Aliases: nil, Description: `Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-createProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-createGroup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups`, QueryParameters: []shared_api.Parameter{ @@ -25370,14 +25361,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createProjectInvitation`, + OperationID: `createGroupInvite`, ShortOperationID: ``, Aliases: nil, Description: `Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupinvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-createProjectInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-createGroupInvite/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/invites`, QueryParameters: []shared_api.Parameter{ @@ -25431,14 +25422,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProject`, + OperationID: `deleteGroup`, ShortOperationID: ``, Aliases: nil, Description: `Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteGroup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}`, QueryParameters: []shared_api.Parameter{ @@ -25492,14 +25483,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProjectInvitation`, + OperationID: `deleteGroupInvite`, ShortOperationID: ``, Aliases: nil, Description: `Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupinvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteProjectInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteGroupInvite/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ @@ -25553,14 +25544,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProjectLimit`, + OperationID: `deleteGroupLimit`, ShortOperationID: ``, Aliases: nil, Description: `Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectlimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegrouplimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteProjectLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-deleteGroupLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -25593,10 +25584,10 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -25604,8 +25595,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |`, +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -25641,14 +25631,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProject`, + OperationID: `getGroup`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}`, QueryParameters: []shared_api.Parameter{ @@ -25702,14 +25692,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProjectByName`, + OperationID: `getGroupByName`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about the project identified by its name. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectbyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupbyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProjectByName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupByName/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/byName/{groupName}`, QueryParameters: []shared_api.Parameter{ @@ -25759,14 +25749,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getProjectInvitation`, + OperationID: `getGroupInvite`, ShortOperationID: ``, Aliases: nil, Description: `Returns the details of one pending invitation to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupinvite. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProjectInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupInvite/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ @@ -25830,14 +25820,75 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProjectLimit`, + OperationID: `getGroupIpAddresses`, + ShortOperationID: ``, + Aliases: nil, + Description: `Returns all IP addresses for this project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupipaddresses. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupIpAddresses/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/ipAddresses`, + 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`}, + }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `getGroupLimit`, ShortOperationID: ``, Aliases: nil, Description: `Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectlimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouplimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProjectLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -25870,10 +25921,10 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -25881,8 +25932,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |`, +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -25918,14 +25968,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProjectLtsVersions`, - ShortOperationID: ``, + OperationID: `getGroupMongoDbVersions`, + ShortOperationID: `getMongoDbVersions`, Aliases: nil, Description: `Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectltsversions. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupmongodbversions. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProjectLtsVersions/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupMongoDbVersions/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/mongoDBVersions`, QueryParameters: []shared_api.Parameter{ @@ -26029,14 +26079,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getProjectSettings`, + OperationID: `getGroupSettings`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about the specified project's settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getProjectSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-getGroupSettings/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/settings`, QueryParameters: []shared_api.Parameter{ @@ -26090,14 +26140,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listProjectInvitations`, + OperationID: `listGroupInvites`, ShortOperationID: ``, Aliases: nil, Description: `Returns all pending invitations to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectinvitations. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupinvites. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listProjectInvitations/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listGroupInvites/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/invites`, QueryParameters: []shared_api.Parameter{ @@ -26161,14 +26211,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listProjectLimits`, + OperationID: `listGroupLimits`, ShortOperationID: ``, Aliases: nil, Description: `Returns all the limits for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectlimits. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouplimits. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listProjectLimits/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listGroupLimits/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/limits`, QueryParameters: []shared_api.Parameter{ @@ -26222,14 +26272,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listProjects`, + OperationID: `listGroups`, ShortOperationID: ``, Aliases: nil, Description: `Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojects. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroups. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listProjects/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-listGroups/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups`, QueryParameters: []shared_api.Parameter{ @@ -26298,14 +26348,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `migrateProjectToAnotherOrg`, + OperationID: `migrateGroup`, ShortOperationID: ``, Aliases: nil, Description: `Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-migrateprojecttoanotherorg. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-migrategroup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-migrateProjectToAnotherOrg/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-migrateGroup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}:migrate`, QueryParameters: []shared_api.Parameter{ @@ -26349,68 +26399,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `returnAllIpAddresses`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns all IP addresses for this project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnallipaddresses. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-returnAllIpAddresses/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/ipAddresses`, - 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`}, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `setProjectLimit`, + OperationID: `setGroupLimit`, ShortOperationID: ``, Aliases: nil, Description: `Sets the specified project limit. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -26418,9 +26407,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setprojectlimit. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-setgrouplimit. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-setProjectLimit/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-setGroupLimit/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/limits/{limitName}`, QueryParameters: []shared_api.Parameter{ @@ -26453,10 +26442,10 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -26464,8 +26453,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |`, +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -26501,14 +26489,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateProject`, + OperationID: `updateGroup`, ShortOperationID: ``, Aliases: nil, Description: `Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroup. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateGroup/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}`, QueryParameters: []shared_api.Parameter{ @@ -26562,16 +26550,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateProjectInvitation`, - ShortOperationID: ``, + OperationID: `updateGroupInviteById`, + ShortOperationID: `updateInviteById`, Aliases: nil, - Description: `Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. To use this resource, the requesting API Key must have the Project Owner role. + Description: `Updates the details of one pending invitation, identified by its unique ID, to the specified project. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitation. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupinvitebyid. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateProjectInvitation/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateGroupInviteById/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/invites`, + URL: `/api/atlas/v2/groups/{groupId}/invites/{invitationId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -26583,16 +26571,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -26609,6 +26587,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `invitationId`, + Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPatch, }, @@ -26623,16 +26611,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateProjectInvitationById`, + OperationID: `updateGroupInvites`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the details of one pending invitation, identified by its unique ID, to the specified project. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. + Description: `Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. To use this resource, the requesting API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectinvitationbyid. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupinvites. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateProjectInvitationById/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateGroupInvites/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/invites/{invitationId}`, + URL: `/api/atlas/v2/groups/{groupId}/invites`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -26644,6 +26632,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -26660,16 +26658,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `invitationId`, - Description: `Unique 24-hexadecimal digit string that identifies the invitation.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodPatch, }, @@ -26684,20 +26672,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateProjectRoles`, + OperationID: `updateGroupSettings`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. + Description: `Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupsettings. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateProjectRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateGroupSettings/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/users/{userId}/roles`, + URL: `/api/atlas/v2/groups/{groupId}/settings`, QueryParameters: []shared_api.Parameter{ { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + 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{ @@ -26706,8 +26694,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - 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.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -26731,18 +26719,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `userId`, - Description: `Unique 24-hexadecimal digit string that identifies the user to modify.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPut, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { @@ -26755,20 +26733,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateProjectSettings`, + OperationID: `updateGroupUserRoles`, ShortOperationID: ``, Aliases: nil, - Description: `Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectsettings. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupuserroles. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateProjectSettings/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-projects-updateGroupUserRoles/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/settings`, + URL: `/api/atlas/v2/groups/{groupId}/users/{userId}/roles`, 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.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -26777,8 +26755,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + 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{ @@ -26802,8 +26780,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `userId`, + Description: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodPatch, + Verb: http.MethodPut, }, Versions: []shared_api.CommandVersion{ { @@ -26822,14 +26810,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.`, Commands: []shared_api.Command{ { - OperationID: `createPushBasedLogConfiguration`, - ShortOperationID: ``, + OperationID: `createGroupPushBasedLogExport`, + ShortOperationID: `createLogExport`, Aliases: nil, Description: `Configures the project level settings for the push-based log export feature. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createpushbasedlogconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategrouppushbasedlogexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-createGroupPushBasedLogExport/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/pushBasedLogExport`, QueryParameters: []shared_api.Parameter{ @@ -26883,14 +26871,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deletePushBasedLogConfiguration`, - ShortOperationID: ``, + OperationID: `deleteGroupPushBasedLogExport`, + ShortOperationID: `deleteLogExport`, Aliases: nil, Description: `Disables the push-based log export feature by resetting the project level settings to its default configuration. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletepushbasedlogconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegrouppushbasedlogexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-deleteGroupPushBasedLogExport/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/pushBasedLogExport`, QueryParameters: []shared_api.Parameter{ @@ -26944,14 +26932,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getPushBasedLogConfiguration`, - ShortOperationID: ``, + OperationID: `getGroupPushBasedLogExport`, + ShortOperationID: `getLogExport`, Aliases: nil, Description: `Fetches the current project level settings for the push-based log export feature. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getpushbasedlogconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgrouppushbasedlogexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-getGroupPushBasedLogExport/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/pushBasedLogExport`, QueryParameters: []shared_api.Parameter{ @@ -27005,14 +26993,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updatePushBasedLogConfiguration`, - ShortOperationID: ``, + OperationID: `updateGroupPushBasedLogExport`, + ShortOperationID: `updateLogExport`, Aliases: nil, Description: `Updates the project level settings for the push-based log export feature. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatepushbasedlogconfiguration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategrouppushbasedlogexport. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-pushBasedLogExport-updateGroupPushBasedLogExport/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/pushBasedLogExport`, QueryParameters: []shared_api.Parameter{ @@ -27073,7 +27061,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Commands: []shared_api.Command{ { OperationID: `getGroupClusterQueryShapeInsightDetails`, - ShortOperationID: ``, + ShortOperationID: `getQueryShapeDetails`, Aliases: nil, Description: `Returns the metadata and statistics summary for a given query shape hash. @@ -27197,14 +27185,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getGroupClusterQueryShapeInsightSummaries`, - ShortOperationID: ``, + OperationID: `listGroupClusterQueryShapeInsightSummaries`, + ShortOperationID: `listQueryShapeSummaries`, 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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterqueryshapeinsightsummaries. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-queryShapeInsights-listGroupClusterQueryShapeInsightSummaries/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries`, QueryParameters: []shared_api.Parameter{ @@ -27492,16 +27480,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getOrgResourcePolicy`, - ShortOperationID: ``, + OperationID: `getOrgNonCompliantResources`, + ShortOperationID: `getNonCompliantResources`, 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-getorgresourcepolicy. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgnoncompliantresources. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getOrgResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-getOrgNonCompliantResources/`, 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`, @@ -27535,16 +27523,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, }, @@ -27559,16 +27537,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getResourcesNonCompliant`, + OperationID: `getOrgResourcePolicy`, ShortOperationID: ``, Aliases: nil, - Description: `Return all non-compliant resources for an 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-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-getorgresourcepolicy. -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-getOrgResourcePolicy/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/nonCompliantResources`, + URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -27602,6 +27580,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, }, @@ -27740,14 +27728,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `validateAtlasResourcePolicy`, - ShortOperationID: ``, + OperationID: `validateOrgResourcePolicies`, + ShortOperationID: `validateResourcePolicies`, Aliases: nil, Description: `Validate 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-validateatlasresourcepolicy. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-validateorgresourcepolicies. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-resourcePolicies-validateOrgResourcePolicies/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate`, QueryParameters: []shared_api.Parameter{ @@ -27803,14 +27791,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster.`, Commands: []shared_api.Command{ { - OperationID: `createRollingIndex`, - ShortOperationID: ``, + OperationID: `createGroupClusterIndexRollingIndex`, + ShortOperationID: `createRollingIndex`, Aliases: nil, Description: `Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createrollingindex. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterindexrollingindex. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-rollingIndex-createRollingIndex/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-rollingIndex-createGroupClusterIndexRollingIndex/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index`, QueryParameters: []shared_api.Parameter{ @@ -27926,14 +27914,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `returnAllControlPlaneIpAddresses`, - ShortOperationID: ``, + OperationID: `listControlPlaneIpAddresses`, + ShortOperationID: `listControlPlaneAddresses`, Aliases: nil, Description: `Returns all control plane IP addresses. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-returnallcontrolplaneipaddresses. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listcontrolplaneipaddresses. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-root-returnAllControlPlaneIpAddresses/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-root-listControlPlaneIpAddresses/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/unauth/controlPlaneIPAddresses`, QueryParameters: []shared_api.Parameter{ @@ -27968,17 +27956,17 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Returns, adds, edits, and removes serverless instances.`, Commands: []shared_api.Command{ { - OperationID: `createServerlessInstance`, - ShortOperationID: ``, + OperationID: `createGroupServerlessInstance`, + ShortOperationID: `createServerlessInstance`, Aliases: nil, Description: `Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. Creates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserverlessinstance. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-createServerlessInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-createGroupServerlessInstance/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless`, QueryParameters: []shared_api.Parameter{ @@ -28032,11 +28020,10 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, - Version: shared_api.NewStableVersion(2024, 11, 13), + OperationID: `createGroupServerlessInstance`, + Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `groupId`: `input:groupId`, - `name`: `body:$.name`, }, }, Expect: &shared_api.WatcherExpectProperties{ @@ -28050,17 +28037,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteServerlessInstance`, - ShortOperationID: ``, + OperationID: `deleteGroupServerlessInstance`, + ShortOperationID: `deleteServerlessInstance`, Aliases: nil, Description: `Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserverlessinstance. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-deleteServerlessInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-deleteGroupServerlessInstance/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{name}`, QueryParameters: []shared_api.Parameter{ @@ -28124,8 +28111,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Watcher: &shared_api.WatcherProperties{ Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, - Version: shared_api.NewStableVersion(2024, 11, 13), + OperationID: `deleteGroupServerlessInstance`, + Version: shared_api.NewStableVersion(2023, 1, 1), Params: map[string]string{ `groupId`: `input:groupId`, `name`: `input:name`, @@ -28138,17 +28125,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServerlessInstance`, - ShortOperationID: ``, + OperationID: `getGroupServerlessInstance`, + ShortOperationID: `getServerlessInstance`, Aliases: nil, Description: `Returns details for one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserverlessinstance. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-getServerlessInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-getGroupServerlessInstance/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{name}`, QueryParameters: []shared_api.Parameter{ @@ -28212,17 +28199,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listServerlessInstances`, - ShortOperationID: ``, + OperationID: `listGroupServerlessInstances`, + ShortOperationID: `listServerlessInstances`, Aliases: nil, Description: `Returns details for all serverless instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint also lists Flex clusters that were created using the createServerlessInstance endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessinstances. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserverlessinstances. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-listServerlessInstances/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-listGroupServerlessInstances/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless`, QueryParameters: []shared_api.Parameter{ @@ -28306,17 +28293,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateServerlessInstance`, - ShortOperationID: ``, + OperationID: `updateGroupServerlessInstance`, + ShortOperationID: `updateServerlessInstance`, Aliases: nil, Description: `Updates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserverlessinstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupserverlessinstance. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-updateServerlessInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessInstances-updateGroupServerlessInstance/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serverless/{name}`, QueryParameters: []shared_api.Parameter{ @@ -28357,8 +28344,173 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `name`, - Description: `Human-readable label that identifies the serverless instance.`, + Name: `name`, + Description: `Human-readable label that identifies the serverless instance.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPatch, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + Watcher: &shared_api.WatcherProperties{ + Get: shared_api.WatcherGetProperties{ + OperationID: `updateGroupServerlessInstance`, + Version: shared_api.NewStableVersion(2023, 1, 1), + Params: map[string]string{ + `groupId`: `input:groupId`, + `name`: `input:name`, + }, + }, + Expect: &shared_api.WatcherExpectProperties{ + Match: &shared_api.WatcherMatchProperties{ + Path: `$.status`, + Values: []string{ + `IDLE`, + }, + }, + }, + }, + }, + }, + }, + { + Name: `Serverless Private Endpoints`, + Description: `Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.`, + Commands: []shared_api.Command{ + { + OperationID: `createGroupPrivateEndpointServerlessInstanceEndpoint`, + ShortOperationID: `createServerlessPrivateEndpoint`, + Aliases: nil, + Description: `Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. + + +This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupprivateendpointserverlessinstanceendpoint. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-createGroupPrivateEndpointServerlessInstanceEndpoint/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint`, + 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`, + }, + }, + }, + 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: `instanceName`, + Description: `Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPost, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: `json`, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `deleteGroupPrivateEndpointServerlessInstanceEndpoint`, + ShortOperationID: `deleteServerlessPrivateEndpoint`, + Aliases: nil, + Description: `Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + + +This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupprivateendpointserverlessinstanceendpoint. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-deleteGroupPrivateEndpointServerlessInstanceEndpoint/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}`, + 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`, + }, + }, + }, + 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: `instanceName`, + Description: `Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `endpointId`, + Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28367,59 +28519,32 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, - Watcher: &shared_api.WatcherProperties{ - Get: shared_api.WatcherGetProperties{ - OperationID: `getFlexCluster`, - Version: shared_api.NewStableVersion(2024, 11, 13), - Params: map[string]string{ - `groupId`: `input:groupId`, - `name`: `input:name`, - }, - }, - Expect: &shared_api.WatcherExpectProperties{ - Match: &shared_api.WatcherMatchProperties{ - Path: `$.status`, - Values: []string{ - `IDLE`, - }, - }, - }, - }, }, - }, - }, - { - Name: `Serverless Private Endpoints`, - Description: `Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.`, - Commands: []shared_api.Command{ { - OperationID: `createServerlessPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `getGroupPrivateEndpointServerlessInstanceEndpoint`, + ShortOperationID: `getServerlessPrivateEndpoint`, Aliases: nil, - Description: `Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. + Description: `Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupprivateendpointserverlessinstanceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-getGroupPrivateEndpointServerlessInstanceEndpoint/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28449,7 +28574,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `instanceName`, - Description: `Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.`, + Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `endpointId`, + Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28458,12 +28593,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPost, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -28471,19 +28606,19 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteServerlessPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `listGroupPrivateEndpointServerlessInstanceEndpoint`, + ShortOperationID: `listServerlessPrivateEndpoint`, Aliases: nil, - Description: `Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupprivateendpointserverlessinstanceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-listGroupPrivateEndpointServerlessInstanceEndpoint/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}`, + URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28513,17 +28648,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `instanceName`, - Description: `Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `endpointId`, - Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.`, + Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28532,7 +28657,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -28545,17 +28670,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServerlessPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `updateGroupPrivateEndpointServerlessInstanceEndpoint`, + ShortOperationID: `updateServerlessPrivateEndpoint`, Aliases: nil, - Description: `Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. + Description: `Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupprivateendpointserverlessinstanceendpoint. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-updateGroupPrivateEndpointServerlessInstanceEndpoint/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}`, QueryParameters: []shared_api.Parameter{ @@ -28587,7 +28712,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `instanceName`, - Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, + Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28597,7 +28722,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `endpointId`, - Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint.`, + Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28606,32 +28731,35 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodGet, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Service Accounts`, + Description: `Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow.`, + Commands: []shared_api.Command{ { - OperationID: `listServerlessPrivateEndpoints`, + OperationID: `createGroupServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. - - -This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. + Description: `Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserverlessprivateendpoints. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createGroupServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28643,6 +28771,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -28659,23 +28797,13 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `instanceName`, - Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), - RequestContentType: ``, + Version: shared_api.NewStableVersion(2024, 8, 5), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -28683,19 +28811,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateServerlessPrivateEndpoint`, - ShortOperationID: ``, + OperationID: `createGroupServiceAccountAccessList`, + ShortOperationID: `createAccessList`, Aliases: nil, - Description: `Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - - -This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. + Description: `Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserverlessprivateendpoint. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserviceaccountaccesslist. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createGroupServiceAccountAccessList/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28707,6 +28832,46 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + 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{ { @@ -28724,18 +28889,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `instanceName`, - Description: `Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `endpointId`, - Description: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -28744,11 +28899,11 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 1, 1), + Version: shared_api.NewStableVersion(2024, 8, 5), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -28756,23 +28911,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - }, - }, - { - Name: `Service Accounts`, - Description: `Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow.`, - Commands: []shared_api.Command{ { - OperationID: `addProjectServiceAccount`, - ShortOperationID: ``, + OperationID: `createGroupServiceAccountSecret`, + ShortOperationID: `createGroupSecret`, Aliases: nil, - Description: `Assigns the specified Service Account to the specified Project. + Description: `Create a secret for the specified Service Account in the specified Project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupserviceaccountsecret. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-addProjectServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createGroupServiceAccountSecret/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28796,16 +28945,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, URLParameters: []shared_api.Parameter{ - { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, { 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. @@ -28820,6 +28959,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `clientId`, + Description: `The Client ID of the Service Account.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPost, }, @@ -28834,16 +28983,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createProjectServiceAccount`, + OperationID: `createOrgServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. + Description: `Creates one Service Account for the specified Organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createProjectServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createOrgServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28868,18 +29017,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, }, Verb: http.MethodPost, @@ -28895,16 +29040,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createProjectServiceAccountAccessList`, - ShortOperationID: ``, + OperationID: `createOrgServiceAccountAccessList`, + ShortOperationID: `createOrgAccessList`, Aliases: nil, - Description: `Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. + Description: `Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgserviceaccountaccesslist. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createOrgServiceAccountAccessList/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -28959,18 +29104,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `clientId`, @@ -28996,16 +29137,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createProjectServiceAccountSecret`, - ShortOperationID: ``, + OperationID: `createOrgServiceAccountSecret`, + ShortOperationID: `createOrgSecret`, Aliases: nil, - Description: `Create a secret for the specified Service Account in the specified Project. + Description: `Create a secret for the specified Service Account. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectserviceaccountsecret. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgserviceaccountsecret. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createOrgServiceAccountSecret/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29030,18 +29171,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `clientId`, @@ -29067,16 +29204,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createServiceAccount`, + OperationID: `deleteGroupServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Creates one Service Account for the specified Organization. + Description: `Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteGroupServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29101,8 +29238,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29110,13 +29247,27 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + 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`}, + }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -29124,16 +29275,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createServiceAccountAccessList`, - ShortOperationID: ``, + OperationID: `deleteGroupServiceAccountAccessListEntry`, + ShortOperationID: `deleteGroupAccessEntry`, Aliases: nil, - Description: `Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. + Description: `Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserviceaccountaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createServiceAccountAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteGroupServiceAccountAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29146,8 +29297,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, + Name: `pretty`, + Description: `Flag that indicates whether the response body should be in the prettyprint format.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -29155,41 +29306,25 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + }, + URLParameters: []shared_api.Parameter{ { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, - Short: ``, - Required: false, + 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: `bool`, + Type: `string`, }, + Aliases: []string{`projectId`}, }, - }, - URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29198,8 +29333,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, + Name: `ipAddress`, + Description: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29208,12 +29343,12 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodPost, + Verb: http.MethodDelete, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: `json`, + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, @@ -29221,16 +29356,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createServiceAccountSecret`, - ShortOperationID: ``, + OperationID: `deleteGroupServiceAccountSecret`, + ShortOperationID: `deleteGroupSecret`, Aliases: nil, - Description: `Create a secret for the specified Service Account. + Description: `Deletes the specified Service Account secret. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createserviceaccountsecret. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupserviceaccountsecret. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-createServiceAccountSecret/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteGroupServiceAccountSecret/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29254,16 +29389,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, URLParameters: []shared_api.Parameter{ - { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, { Name: `clientId`, Description: `The Client ID of the Service Account.`, @@ -29274,56 +29399,9 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `deleteProjectServiceAccount`, - ShortOperationID: ``, - Aliases: nil, - Description: `Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccount. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteProjectServiceAccount/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}`, - 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: `clientId`, - Description: `The Client ID of the Service Account.`, + Name: `secretId`, + Description: `Unique 24-hexadecimal digit string that identifies the secret.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29359,16 +29437,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProjectServiceAccountAccessListEntry`, + OperationID: `deleteOrgServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. + Description: `Deletes the specified Service Account. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountaccesslistentry. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteOrgServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29392,20 +29470,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, 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: `clientId`, Description: `The Client ID of the Service Account.`, @@ -29417,8 +29481,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `ipAddress`, - Description: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29440,16 +29504,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteProjectServiceAccountSecret`, - ShortOperationID: ``, + OperationID: `deleteOrgServiceAccountAccessListEntry`, + ShortOperationID: `deleteOrgAccessEntry`, Aliases: nil, - Description: `Deletes the specified Service Account secret. + Description: `Removes the specified access list entry from the specified Service Account for the organization. You can't remove the requesting IP address from the access list. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprojectserviceaccountsecret. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgserviceaccountaccesslistentry. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteOrgServiceAccountAccessListEntry/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29474,8 +29538,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29484,8 +29548,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `secretId`, - Description: `Unique 24-hexadecimal digit string that identifies the secret.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29494,18 +29558,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - 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, + Name: `ipAddress`, + Description: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, }, Verb: http.MethodDelete, @@ -29521,16 +29581,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteServiceAccount`, - ShortOperationID: ``, + OperationID: `deleteOrgServiceAccountSecret`, + ShortOperationID: `deleteOrgSecret`, Aliases: nil, - Description: `Deletes the specified Service Account. + Description: `Deletes the specified Service Account secret. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgserviceaccountsecret. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteOrgServiceAccountSecret/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29564,6 +29624,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `secretId`, + Description: `Unique 24-hexadecimal digit string that identifies the secret.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, { Name: `orgId`, Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, @@ -29588,16 +29658,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteServiceAccountAccessListEntry`, + OperationID: `getGroupServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Removes the specified access list entry from the specified Service Account for the organization. You can't remove the requesting IP address from the access list. + Description: `Returns one Service Account in the specified Project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountaccesslistentry. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-getGroupServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29622,14 +29692,18 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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: `clientId`, @@ -29641,18 +29715,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, - { - Name: `ipAddress`, - Description: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -29665,16 +29729,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteServiceAccountSecret`, + OperationID: `getOrgServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Deletes the specified Service Account secret. + Description: `Returns the specified Service Account. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteserviceaccountsecret. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-deleteServiceAccountSecret/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-getOrgServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29699,18 +29763,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `secretId`, - Description: `Unique 24-hexadecimal digit string that identifies the secret.`, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29719,8 +29773,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29729,7 +29783,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, }, - Verb: http.MethodDelete, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { @@ -29742,25 +29796,35 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getProjectServiceAccount`, - ShortOperationID: ``, + OperationID: `getOrgServiceAccountGroups`, + ShortOperationID: `getServiceAccountGroups`, Aliases: nil, - Description: `Returns one Service Account in the specified Project. + Description: `Returns a list of all projects the specified Service Account is a part of. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgserviceaccountgroups. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-getProjectServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-getOrgServiceAccountGroups/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}`, + URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups`, 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.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, }, }, { @@ -29773,21 +29837,27 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, + { + 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`, + }, + }, }, 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, { Name: `clientId`, @@ -29813,16 +29883,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getServiceAccount`, + OperationID: `inviteGroupServiceAccount`, ShortOperationID: ``, Aliases: nil, - Description: `Returns the specified Service Account. + Description: `Assigns the specified Service Account to the specified Project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-invitegroupserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-getServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-inviteGroupServiceAccount/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}`, + URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -29847,8 +29917,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Name: `clientId`, + Description: `The Client ID of the Service Account.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -29857,22 +29927,26 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, - Short: ``, - Required: true, + 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`}, }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -29880,14 +29954,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listProjectServiceAccountAccessList`, - ShortOperationID: ``, + OperationID: `listGroupServiceAccountAccessList`, + ShortOperationID: `listAccessList`, Aliases: nil, Description: `Returns all access list entries that you configured for the specified Service Account for the project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccountaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserviceaccountaccesslist. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listGroupServiceAccountAccessList/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList`, QueryParameters: []shared_api.Parameter{ @@ -29981,14 +30055,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listProjectServiceAccounts`, + OperationID: `listGroupServiceAccounts`, ShortOperationID: ``, Aliases: nil, Description: `Returns all Service Accounts for the specified Project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectserviceaccounts. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupserviceaccounts. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listProjectServiceAccounts/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listGroupServiceAccounts/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts`, QueryParameters: []shared_api.Parameter{ @@ -30062,14 +30136,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listServiceAccountAccessList`, - ShortOperationID: ``, + OperationID: `listOrgServiceAccountAccessList`, + ShortOperationID: `listOrgAccessList`, Aliases: nil, Description: `Returns all access list entries that you configured for the specified Service Account for the organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountaccesslist. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgserviceaccountaccesslist. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listServiceAccountAccessList/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listOrgServiceAccountAccessList/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList`, QueryParameters: []shared_api.Parameter{ @@ -30159,101 +30233,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listServiceAccountProjects`, - ShortOperationID: ``, - Aliases: nil, - Description: `Returns a list of all projects the specified Service Account is a part of. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccountprojects. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listServiceAccountProjects/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups`, - QueryParameters: []shared_api.Parameter{ - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - 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: `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`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `clientId`, - Description: `The Client ID of the Service Account.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2024, 8, 5), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `listServiceAccounts`, + OperationID: `listOrgServiceAccounts`, ShortOperationID: ``, Aliases: nil, Description: `Returns all Service Accounts for the specified Organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listserviceaccounts. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgserviceaccounts. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listServiceAccounts/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-listOrgServiceAccounts/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts`, QueryParameters: []shared_api.Parameter{ @@ -30323,14 +30310,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateProjectServiceAccount`, + OperationID: `updateGroupServiceAccount`, ShortOperationID: ``, Aliases: nil, Description: `Updates one Service Account in the specified Project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateprojectserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-updateProjectServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-updateGroupServiceAccount/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ @@ -30394,14 +30381,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateServiceAccount`, + OperationID: `updateOrgServiceAccount`, ShortOperationID: ``, Aliases: nil, Description: `Updates the specified Service Account in the specified Organization. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateserviceaccount. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateorgserviceaccount. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-updateServiceAccount/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-serviceAccounts-updateOrgServiceAccount/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}`, QueryParameters: []shared_api.Parameter{ @@ -30467,17 +30454,17 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Description: `Returns and adds restore jobs for shared-tier database deployments.`, Commands: []shared_api.Command{ { - OperationID: `createSharedClusterBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `createGroupClusterBackupTenantRestore`, + ShortOperationID: `createBackupTenantRestore`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createsharedclusterbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclusterbackuptenantrestore. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-createGroupClusterBackupTenantRestore/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore`, QueryParameters: []shared_api.Parameter{ @@ -30541,17 +30528,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getSharedClusterBackupRestoreJob`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupTenantRestore`, + ShortOperationID: `getBackupTenantRestore`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsharedclusterbackuprestorejob. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuptenantrestore. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-getGroupClusterBackupTenantRestore/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}`, QueryParameters: []shared_api.Parameter{ @@ -30625,17 +30612,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listSharedClusterBackupRestoreJobs`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupTenantRestores`, + ShortOperationID: `listBackupTenantRestores`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsharedclusterbackuprestorejobs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuptenantrestores. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierRestoreJobs-listGroupClusterBackupTenantRestores/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores`, QueryParameters: []shared_api.Parameter{ @@ -30705,17 +30692,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns and requests to download shared-tier database deployment snapshots.`, Commands: []shared_api.Command{ { - OperationID: `downloadSharedClusterBackup`, - ShortOperationID: ``, + OperationID: `downloadGroupClusterBackupTenant`, + ShortOperationID: `downloadClusterBackupTenant`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadsharedclusterbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusterbackuptenant. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-downloadGroupClusterBackupTenant/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download`, QueryParameters: []shared_api.Parameter{ @@ -30779,17 +30766,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getSharedClusterBackup`, - ShortOperationID: ``, + OperationID: `getGroupClusterBackupTenantSnapshot`, + ShortOperationID: `getBackupTenantSnapshot`, Aliases: nil, 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getsharedclusterbackup. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterbackuptenantsnapshot. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-getGroupClusterBackupTenantSnapshot/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}`, QueryParameters: []shared_api.Parameter{ @@ -30839,90 +30826,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, - { - Name: `snapshotId`, - Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, - 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: `listSharedClusterBackups`, - ShortOperationID: ``, - Aliases: nil, - 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listsharedclusterbackups. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots`, - 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: `clusterName`, - Description: `Human-readable label that identifies the cluster.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, + { + Name: `snapshotId`, + Description: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -30936,23 +30849,20 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - }, - }, - { - Name: `Streams`, - Description: `Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.`, - Commands: []shared_api.Command{ { - OperationID: `acceptVpcPeeringConnection`, - ShortOperationID: ``, + OperationID: `listGroupClusterBackupTenantSnapshots`, + ShortOperationID: `listClusterBackupSnapshots`, Aliases: nil, - Description: `Requests the acceptance of an incoming VPC Peering connection. + 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 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 command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acceptvpcpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterbackuptenantsnapshots. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-acceptVpcPeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-sharedTierSnapshots-listGroupClusterBackupTenantSnapshots/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept`, + URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -30964,6 +30874,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -30981,8 +30901,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `id`, - Description: `The VPC Peering Connection id.`, + Name: `clusterName`, + Description: `Human-readable label that identifies the cluster.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -30991,29 +30911,35 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPost, + Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), - RequestContentType: `json`, + Version: shared_api.NewStableVersion(2023, 1, 1), + RequestContentType: ``, ResponseContentTypes: []string{ `json`, }, }, }, }, + }, + }, + { + Name: `Streams`, + Description: `Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.`, + Commands: []shared_api.Command{ { - OperationID: `createPrivateLinkConnection`, - ShortOperationID: ``, + OperationID: `acceptGroupStreamVpcPeeringConnection`, + ShortOperationID: `acceptVpcPeeringConnection`, Aliases: nil, - Description: `Creates one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. + Description: `Requests the acceptance of an incoming VPC Peering connection. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-acceptgroupstreamvpcpeeringconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createPrivateLinkConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-acceptGroupStreamVpcPeeringConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections`, + URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31025,16 +30951,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -31051,6 +30967,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `id`, + Description: `The VPC Peering Connection id.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPost, }, @@ -31065,14 +30991,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createStreamConnection`, - ShortOperationID: ``, + OperationID: `createGroupStreamConnection`, + ShortOperationID: `createStreamConnection`, Aliases: nil, Description: `Creates one connection for a stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createStreamConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createGroupStreamConnection/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections`, QueryParameters: []shared_api.Parameter{ @@ -31136,16 +31062,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createStreamInstance`, - ShortOperationID: ``, + OperationID: `createGroupStreamPrivateLinkConnection`, + ShortOperationID: `createPrivateLinkConnection`, Aliases: nil, - Description: `Creates one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + Description: `Creates one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamprivatelinkconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createStreamInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createGroupStreamPrivateLinkConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams`, + URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31197,16 +31123,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createStreamInstanceWithSampleConnections`, - ShortOperationID: ``, + OperationID: `createGroupStreamProcessor`, + ShortOperationID: `createStreamProcessor`, Aliases: nil, - Description: `Creates one stream instance in the specified project with sample connections. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + Description: `Create one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreaminstancewithsampleconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createStreamInstanceWithSampleConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams:withSampleConnections`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31244,12 +31170,22 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `tenantName`, + Description: `Human-readable label that identifies the stream instance.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 8, 5), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -31258,16 +31194,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `createStreamProcessor`, - ShortOperationID: ``, + OperationID: `createGroupStreamWorkspace`, + ShortOperationID: `createStreamWorkspace`, Aliases: nil, - Description: `Create one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Creates one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupstreamworkspace. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createGroupStreamWorkspace/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor`, + URL: `/api/atlas/v2/groups/{groupId}/streams`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31305,22 +31241,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 5, 30), + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -31329,16 +31255,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deletePrivateLinkConnection`, - ShortOperationID: ``, + OperationID: `deleteGroupStreamConnection`, + ShortOperationID: `deleteStreamConnection`, Aliases: nil, - Description: `Deletes one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. + Description: `Delete one connection of the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deletePrivateLinkConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteGroupStreamConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31377,8 +31303,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `connectionId`, - Description: `Unique ID that identifies the Private Link connection.`, + Name: `tenantName`, + Description: `Human-readable label that identifies the stream instance.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `connectionName`, + Description: `Human-readable label that identifies the stream connection.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -31400,16 +31336,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteStreamConnection`, - ShortOperationID: ``, + OperationID: `deleteGroupStreamPrivateLinkConnection`, + ShortOperationID: `deletePrivateLinkConnection`, Aliases: nil, - Description: `Delete one connection of the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Deletes one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamprivatelinkconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteStreamConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteGroupStreamPrivateLinkConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31448,18 +31384,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `connectionName`, - Description: `Human-readable label that identifies the stream connection.`, + Name: `connectionId`, + Description: `Unique ID that identifies the Private Link connection.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -31481,16 +31407,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteStreamInstance`, - ShortOperationID: ``, + OperationID: `deleteGroupStreamProcessor`, + ShortOperationID: `deleteStreamProcessor`, Aliases: nil, - Description: `Delete one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + Description: `Delete a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreaminstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteStreamInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31530,7 +31456,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance to delete.`, + Description: `Human-readable label that identifies the stream instance.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `processorName`, + Description: `Human-readable label that identifies the stream processor.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -31543,7 +31479,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -31552,16 +31488,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteStreamProcessor`, - ShortOperationID: ``, + OperationID: `deleteGroupStreamVpcPeeringConnection`, + ShortOperationID: `deleteVpcPeeringConnection`, Aliases: nil, - Description: `Delete a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Deletes an incoming VPC Peering connection. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletestreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamvpcpeeringconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteGroupStreamVpcPeeringConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31573,16 +31509,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -31600,18 +31526,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `processorName`, - Description: `Human-readable label that identifies the stream processor.`, + Name: `id`, + Description: `The VPC Peering Connection id.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -31624,7 +31540,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 5, 30), + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -31633,16 +31549,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteVpcPeeringConnection`, - ShortOperationID: ``, + OperationID: `deleteGroupStreamWorkspace`, + ShortOperationID: `deleteStreamWorkspace`, Aliases: nil, - Description: `Deletes an incoming VPC Peering connection. + Description: `Delete one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletevpcpeeringconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupstreamworkspace. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteVpcPeeringConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteGroupStreamWorkspace/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31654,6 +31570,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -31671,8 +31597,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, { - Name: `id`, - Description: `The VPC Peering Connection id.`, + Name: `tenantName`, + Description: `Human-readable label that identifies the stream instance to delete.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -31694,14 +31620,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `downloadStreamTenantAuditLogs`, - ShortOperationID: ``, + OperationID: `downloadGroupStreamAuditLogs`, + ShortOperationID: `downloadAuditLogs`, Aliases: nil, Description: `Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadstreamtenantauditlogs. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupstreamauditlogs. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-downloadStreamTenantAuditLogs/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-downloadGroupStreamAuditLogs/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs`, QueryParameters: []shared_api.Parameter{ @@ -31775,14 +31701,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getAccountDetails`, - ShortOperationID: ``, + OperationID: `getGroupStreamAccountDetails`, + ShortOperationID: `getAccountDetails`, Aliases: nil, Description: `Returns the Account ID, and the VPC ID for the group and region specified. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getaccountdetails. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamaccountdetails. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getAccountDetails/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamAccountDetails/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams/accountDetails`, QueryParameters: []shared_api.Parameter{ @@ -31846,16 +31772,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getActiveVpcPeeringConnections`, - ShortOperationID: ``, + OperationID: `getGroupStreamConnection`, + ShortOperationID: `getStreamConnection`, Aliases: nil, - Description: `Returns a list of active incoming VPC Peering Connections. + Description: `Returns the details of one stream connection within the specified stream instance. 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-getactivevpcpeeringconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getActiveVpcPeeringConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -31867,36 +31793,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - 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{ { @@ -31913,12 +31809,32 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `tenantName`, + Description: `Human-readable label that identifies the stream instance to return.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + { + Name: `connectionName`, + Description: `Human-readable label that identifies the stream connection to return.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 11, 13), + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -31927,14 +31843,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getPrivateLinkConnection`, - ShortOperationID: ``, + OperationID: `getGroupStreamPrivateLinkConnection`, + ShortOperationID: `getPrivateLinkConnection`, Aliases: nil, Description: `Returns the details of one Private Link connection within the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprivatelinkconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprivatelinkconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getPrivateLinkConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamPrivateLinkConnection/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}`, QueryParameters: []shared_api.Parameter{ @@ -31988,16 +31904,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getStreamConnection`, - ShortOperationID: ``, + OperationID: `getGroupStreamProcessor`, + ShortOperationID: `getStreamProcessor`, Aliases: nil, - Description: `Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getStreamConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32009,6 +31925,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c 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{ { @@ -32027,7 +31953,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance to return.`, + Description: `Human-readable label that identifies the stream instance.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -32036,8 +31962,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `connectionName`, - Description: `Human-readable label that identifies the stream connection to return.`, + Name: `processorName`, + Description: `Human-readable label that identifies the stream processor.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -32050,7 +31976,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -32059,16 +31985,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getStreamInstance`, - ShortOperationID: ``, + OperationID: `getGroupStreamProcessors`, + ShortOperationID: `getStreamProcessors`, Aliases: nil, - Description: `Returns the details of one stream instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. + Description: `Returns all Stream Processors within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreaminstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamprocessors. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getStreamInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamProcessors/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32081,8 +32007,38 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `includeConnections`, - Description: `Flag to indicate whether connections information should be included in the stream instance.`, + 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: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `includeCount`, + Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -32108,7 +32064,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance to return.`, + Description: `Human-readable label that identifies the stream instance.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -32121,7 +32077,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), + Version: shared_api.NewStableVersion(2024, 5, 30), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -32130,16 +32086,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getStreamProcessor`, - ShortOperationID: ``, + OperationID: `getGroupStreamWorkspace`, + ShortOperationID: `getStreamWorkspace`, Aliases: nil, - Description: `Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Returns the details of one stream instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamworkspace. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getGroupStreamWorkspace/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32152,8 +32108,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `includeConnections`, + Description: `Flag to indicate whether connections information should be included in the stream instance.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -32179,17 +32135,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `processorName`, - Description: `Human-readable label that identifies the stream processor.`, + Description: `Human-readable label that identifies the stream instance to return.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -32202,7 +32148,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2024, 5, 30), + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: ``, ResponseContentTypes: []string{ `json`, @@ -32211,27 +32157,98 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getVpcPeeringConnections`, - ShortOperationID: ``, + OperationID: `listGroupStreamActiveVpcPeeringConnections`, + ShortOperationID: `listActivePeeringConnections`, Aliases: nil, - Description: `Returns a list of incoming VPC Peering Connections. + Description: `Returns a list of active incoming VPC Peering Connections. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getvpcpeeringconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamactivevpcpeeringconnections. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getVpcPeeringConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listGroupStreamActiveVpcPeeringConnections/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections`, + URL: `/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections`, QueryParameters: []shared_api.Parameter{ { - Name: `requesterAccountId`, - Description: `The Account ID of the VPC Peering connection/s.`, + 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: true, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `bool`, + }, + }, + { + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `int`, + }, + }, + { + 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`}, }, + }, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2024, 11, 13), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `listGroupStreamConnections`, + ShortOperationID: `listStreamConnections`, + Aliases: nil, + Description: `Returns all connections of the stream instance for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamconnections. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listGroupStreamConnections/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections`, + 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.`, @@ -32288,6 +32305,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, + { + Name: `tenantName`, + Description: `Human-readable label that identifies the stream instance.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, Verb: http.MethodGet, }, @@ -32302,14 +32329,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listPrivateLinkConnections`, - ShortOperationID: ``, + OperationID: `listGroupStreamPrivateLinkConnections`, + ShortOperationID: `listPrivateLinkConnections`, Aliases: nil, Description: `Returns all Private Link connections for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listprivatelinkconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamprivatelinkconnections. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listPrivateLinkConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listGroupStreamPrivateLinkConnections/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections`, QueryParameters: []shared_api.Parameter{ @@ -32383,17 +32410,27 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listStreamConnections`, - ShortOperationID: ``, + OperationID: `listGroupStreamVpcPeeringConnections`, + ShortOperationID: `listVpcPeeringConnections`, Aliases: nil, - Description: `Returns all connections of the stream instance for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. + Description: `Returns a list of incoming VPC Peering Connections. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamconnections. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamvpcpeeringconnections. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listStreamConnections/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listGroupStreamVpcPeeringConnections/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections`, + URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections`, QueryParameters: []shared_api.Parameter{ + { + Name: `requesterAccountId`, + Description: `The Account ID of the VPC Peering connection/s.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + 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.`, @@ -32450,16 +32487,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, Verb: http.MethodGet, }, @@ -32474,14 +32501,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listStreamInstances`, - ShortOperationID: ``, + OperationID: `listGroupStreamWorkspaces`, + ShortOperationID: `listStreamWorkspaces`, Aliases: nil, Description: `Returns all stream instances for the specified project. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreaminstances. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupstreamworkspaces. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listStreamInstances/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listGroupStreamWorkspaces/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/streams`, QueryParameters: []shared_api.Parameter{ @@ -32542,7 +32569,68 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Aliases: []string{`projectId`}, }, }, - Verb: http.MethodGet, + Verb: http.MethodGet, + }, + Versions: []shared_api.CommandVersion{ + { + Version: shared_api.NewStableVersion(2023, 2, 1), + RequestContentType: ``, + ResponseContentTypes: []string{ + `json`, + }, + }, + }, + }, + { + OperationID: `rejectGroupStreamVpcPeeringConnection`, + ShortOperationID: `rejectVpcPeeringConnection`, + Aliases: nil, + Description: `Requests the rejection of an incoming VPC Peering connection. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-rejectgroupstreamvpcpeeringconnection. + +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-rejectGroupStreamVpcPeeringConnection/`, + RequestParameters: shared_api.RequestParameters{ + URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject`, + 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`, + }, + }, + }, + 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: `id`, + Description: `The VPC Peering Connection id.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, + }, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -32555,16 +32643,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listStreamProcessors`, - ShortOperationID: ``, + OperationID: `startGroupStreamProcessor`, + ShortOperationID: `startStreamProcessor`, Aliases: nil, - Description: `Returns all Stream Processors within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-liststreamprocessors. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listStreamProcessors/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-startGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32586,36 +32674,6 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `bool`, }, }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `includeCount`, - Description: `Flag that indicates whether the response returns the total number of items (totalCount) in the response.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, }, URLParameters: []shared_api.Parameter{ { @@ -32642,8 +32700,18 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Type: `string`, }, }, + { + Name: `processorName`, + Description: `Human-readable label that identifies the stream processor.`, + Short: ``, + Required: true, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, - Verb: http.MethodGet, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { @@ -32656,16 +32724,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `modifyStreamProcessor`, - ShortOperationID: ``, + OperationID: `startGroupStreamProcessorWith`, + ShortOperationID: `startStreamProcessorWith`, Aliases: nil, - Description: `Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-modifystreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startgroupstreamprocessorwith. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-modifyStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-startGroupStreamProcessorWith/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32724,73 +32792,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPatch, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, - { - OperationID: `rejectVpcPeeringConnection`, - ShortOperationID: ``, - Aliases: nil, - Description: `Requests the rejection of an incoming VPC Peering connection. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-rejectvpcpeeringconnection. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-rejectVpcPeeringConnection/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject`, - 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`, - }, - }, - }, - 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: `id`, - Description: `The VPC Peering Connection id.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), - RequestContentType: ``, + Version: shared_api.NewStableVersion(2025, 3, 12), + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -32798,16 +32805,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `startStreamProcessor`, - ShortOperationID: ``, + OperationID: `stopGroupStreamProcessor`, + ShortOperationID: `stopStreamProcessor`, Aliases: nil, - Description: `Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Stop a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-stopgroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-startStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-stopGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32879,16 +32886,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `startStreamProcessorWith`, - ShortOperationID: ``, + OperationID: `updateGroupStreamConnection`, + ShortOperationID: `updateStreamConnection`, Aliases: nil, - Description: `Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Update one connection for the specified stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-startstreamprocessorwith. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamconnection. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-startStreamProcessorWith/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-updateGroupStreamConnection/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -32937,8 +32944,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - Name: `processorName`, - Description: `Human-readable label that identifies the stream processor.`, + Name: `connectionName`, + Description: `Human-readable label that identifies the stream connection.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -32947,11 +32954,11 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPost, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2025, 3, 12), + Version: shared_api.NewStableVersion(2023, 2, 1), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -32960,16 +32967,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `stopStreamProcessor`, - ShortOperationID: ``, + OperationID: `updateGroupStreamProcessor`, + ShortOperationID: `updateStreamProcessor`, Aliases: nil, - Description: `Stop a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-stopstreamprocessor. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamprocessor. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-stopStreamProcessor/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-updateGroupStreamProcessor/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -33028,12 +33035,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - Verb: http.MethodPost, + Verb: http.MethodPatch, }, Versions: []shared_api.CommandVersion{ { Version: shared_api.NewStableVersion(2024, 5, 30), - RequestContentType: ``, + RequestContentType: `json`, ResponseContentTypes: []string{ `json`, }, @@ -33041,16 +33048,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateStreamConnection`, - ShortOperationID: ``, + OperationID: `updateGroupStreamWorkspace`, + ShortOperationID: `updateStreamWorkspace`, Aliases: nil, - Description: `Update one connection for the specified stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + Description: `Update one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreamconnection. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupstreamworkspace. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-updateStreamConnection/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-updateGroupStreamWorkspace/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -33090,17 +33097,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, { Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - { - Name: `connectionName`, - Description: `Human-readable label that identifies the stream connection.`, + Description: `Human-readable label that identifies the stream instance to update.`, Short: ``, Required: true, Type: shared_api.ParameterType{ @@ -33122,16 +33119,16 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateStreamInstance`, - ShortOperationID: ``, + OperationID: `withGroupStreamSampleConnections`, + ShortOperationID: `withStreamSampleConnections`, Aliases: nil, - Description: `Update one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. + Description: `Creates one stream instance in the specified project with sample connections. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatestreaminstance. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-withgroupstreamsampleconnections. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-updateStreamInstance/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-withGroupStreamSampleConnections/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streams/{tenantName}`, + URL: `/api/atlas/v2/groups/{groupId}/streams:withSampleConnections`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -33169,22 +33166,12 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, Aliases: []string{`projectId`}, }, - { - Name: `tenantName`, - Description: `Human-readable label that identifies the stream instance to update.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, }, - Verb: http.MethodPatch, + Verb: http.MethodPost, }, Versions: []shared_api.CommandVersion{ { - Version: shared_api.NewStableVersion(2023, 2, 1), + Version: shared_api.NewStableVersion(2024, 8, 5), RequestContentType: `json`, ResponseContentTypes: []string{ `json`, @@ -33199,14 +33186,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, adds, edits, or removes teams.`, Commands: []shared_api.Command{ { - OperationID: `addAllTeamsToProject`, + OperationID: `addGroupTeams`, ShortOperationID: ``, Aliases: nil, Description: `Adds one or more teams to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addallteamstoproject. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addgroupteams. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-addAllTeamsToProject/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-addGroupTeams/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/teams`, QueryParameters: []shared_api.Parameter{ @@ -33260,17 +33247,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `addTeamUser`, - ShortOperationID: ``, + OperationID: `addOrgTeamUsers`, + ShortOperationID: `addTeamUsers`, Aliases: nil, Description: `Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Add One MongoDB Cloud User to One Team to add an active or pending user to a team. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addteamuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addorgteamusers. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-addTeamUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-addOrgTeamUsers/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users`, QueryParameters: []shared_api.Parameter{ @@ -33330,14 +33317,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `createTeam`, + OperationID: `createOrgTeam`, ShortOperationID: ``, Aliases: nil, Description: `Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createteam. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-createTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-createOrgTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams`, QueryParameters: []shared_api.Parameter{ @@ -33387,14 +33374,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `deleteTeam`, + OperationID: `deleteOrgTeam`, ShortOperationID: ``, Aliases: nil, Description: `Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteteam. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deleteorgteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-deleteTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-deleteOrgTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -33454,14 +33441,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getProjectTeam`, + OperationID: `getGroupTeam`, ShortOperationID: ``, 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. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getProjectTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getGroupTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -33525,14 +33512,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getTeamById`, + OperationID: `getOrgTeam`, ShortOperationID: ``, Aliases: nil, Description: `Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyid. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getTeamById/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getOrgTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -33592,14 +33579,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `getTeamByName`, - ShortOperationID: ``, + OperationID: `getOrgTeamByName`, + ShortOperationID: `getTeamByName`, Aliases: nil, Description: `Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getteambyname. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgteambyname. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getTeamByName/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-getOrgTeamByName/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}`, QueryParameters: []shared_api.Parameter{ @@ -33659,16 +33646,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listOrganizationTeams`, + OperationID: `listGroupTeams`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. + Description: `Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting 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-listorganizationteams. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupteams. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-listOrganizationTeams/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-listGroupTeams/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/orgs/{orgId}/teams`, + URL: `/api/atlas/v2/groups/{groupId}/teams`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -33681,13 +33668,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, + 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: `int`, + Type: `bool`, }, }, { @@ -33701,8 +33688,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -33711,26 +33698,30 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, }, }, }, URLParameters: []shared_api.Parameter{ { - Name: `orgId`, - Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, - Short: ``, - Required: true, + 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`}, }, }, Verb: http.MethodGet, @@ -33746,16 +33737,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `listProjectTeams`, + OperationID: `listOrgTeams`, ShortOperationID: ``, Aliases: nil, - Description: `Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. + Description: `Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting 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-listprojectteams. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgteams. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-listProjectTeams/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-listOrgTeams/`, RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/teams`, + URL: `/api/atlas/v2/orgs/{orgId}/teams`, QueryParameters: []shared_api.Parameter{ { Name: `envelope`, @@ -33768,13 +33759,13 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pretty`, - Description: `Flag that indicates whether the response body should be in the prettyprint format.`, + Name: `itemsPerPage`, + Description: `Number of items that the response returns per page.`, Short: ``, Required: false, Type: shared_api.ParameterType{ IsArray: false, - Type: `bool`, + Type: `int`, }, }, { @@ -33788,8 +33779,8 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, + Name: `pageNum`, + Description: `Number of the page that displays the current set of the total objects that the response returns.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -33798,30 +33789,26 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, + 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: `int`, + 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, + Name: `orgId`, + Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`, + Short: ``, + Required: true, Type: shared_api.ParameterType{ IsArray: false, Type: `string`, }, - Aliases: []string{`projectId`}, }, }, Verb: http.MethodGet, @@ -33837,14 +33824,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `removeProjectTeam`, + OperationID: `removeGroupTeam`, ShortOperationID: ``, Aliases: nil, Description: `Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeprojectteam. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removegroupteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-removeProjectTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-removeGroupTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -33898,17 +33885,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `removeTeamUser`, - ShortOperationID: ``, + OperationID: `removeOrgTeamUserFromTeam`, + ShortOperationID: `removeUserFromTeam`, Aliases: nil, Description: `Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Remove One MongoDB Cloud User from One Team to remove an active or pending user from a team. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeteamuser. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorgteamuserfromteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-removeTeamUser/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-removeOrgTeamUserFromTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}`, QueryParameters: []shared_api.Parameter{ @@ -33978,14 +33965,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `renameTeam`, + OperationID: `renameOrgTeam`, ShortOperationID: ``, Aliases: nil, Description: `Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-renameteam. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-renameorgteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-renameTeam/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-renameOrgTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/orgs/{orgId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -34045,14 +34032,14 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, }, { - OperationID: `updateTeamRoles`, + OperationID: `updateGroupTeam`, ShortOperationID: ``, Aliases: nil, 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. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateteamroles. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupteam. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-updateTeamRoles/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-teams-updateGroupTeam/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/teams/{teamId}`, QueryParameters: []shared_api.Parameter{ @@ -34125,14 +34112,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you IMPORTANT: Each project can only have one configuration per integrationType.`, Commands: []shared_api.Command{ { - OperationID: `createThirdPartyIntegration`, + OperationID: `createGroupIntegration`, ShortOperationID: ``, Aliases: nil, Description: `Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createthirdpartyintegration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupintegration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-createGroupIntegration/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/integrations/{integrationType}`, QueryParameters: []shared_api.Parameter{ @@ -34226,14 +34213,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `deleteThirdPartyIntegration`, + OperationID: `deleteGroupIntegration`, ShortOperationID: ``, Aliases: nil, Description: `Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletethirdpartyintegration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletegroupintegration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-deleteGroupIntegration/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/integrations/{integrationType}`, QueryParameters: []shared_api.Parameter{ @@ -34297,14 +34284,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `getThirdPartyIntegration`, + OperationID: `getGroupIntegration`, ShortOperationID: ``, Aliases: nil, Description: `Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getthirdpartyintegration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupintegration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-getGroupIntegration/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/integrations/{integrationType}`, QueryParameters: []shared_api.Parameter{ @@ -34368,14 +34355,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listThirdPartyIntegrations`, + OperationID: `listGroupIntegrations`, ShortOperationID: ``, Aliases: nil, Description: `Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listthirdpartyintegrations. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupintegrations. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-listGroupIntegrations/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/integrations`, QueryParameters: []shared_api.Parameter{ @@ -34459,14 +34446,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `updateThirdPartyIntegration`, + OperationID: `updateGroupIntegration`, ShortOperationID: ``, Aliases: nil, Description: `Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updatethirdpartyintegration. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupintegration. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-thirdPartyIntegrations-updateGroupIntegration/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/integrations/{integrationType}`, QueryParameters: []shared_api.Parameter{ @@ -34566,8 +34553,8 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you Description: `Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.`, Commands: []shared_api.Command{ { - OperationID: `createDatabaseUserCertificate`, - ShortOperationID: ``, + OperationID: `createGroupDatabaseUserCert`, + ShortOperationID: `createDatabaseUserCert`, Aliases: nil, Description: `Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -34577,9 +34564,9 @@ To get MongoDB Cloud to generate a managed certificate for a database user, set If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createdatabaseusercertificate. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupdatabaseusercert. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-createDatabaseUserCertificate/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-createGroupDatabaseUserCert/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs`, QueryParameters: []shared_api.Parameter{ @@ -34643,17 +34630,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `disableCustomerManagedX509`, - ShortOperationID: ``, + OperationID: `disableGroupUserSecurityCustomerX509`, + ShortOperationID: `disableSecurityCustomerX509`, Aliases: nil, Description: `Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablecustomermanagedx509. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablegroupusersecuritycustomerx509. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-disableCustomerManagedX509/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-disableGroupUserSecurityCustomerX509/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/userSecurity/customerX509`, QueryParameters: []shared_api.Parameter{ @@ -34697,14 +34684,14 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, { - OperationID: `listDatabaseUserCertificates`, - ShortOperationID: ``, + OperationID: `listGroupDatabaseUserCerts`, + ShortOperationID: `listDatabaseUserCerts`, Aliases: nil, Description: `Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listdatabaseusercertificates. +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupdatabaseusercerts. -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-listDatabaseUserCertificates/`, +For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-listGroupDatabaseUserCerts/`, RequestParameters: shared_api.RequestParameters{ URL: `/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs`, QueryParameters: []shared_api.Parameter{ diff --git a/test/e2e/atlas/autogeneration/autogeneratedcommands/autogenerated_commands_test.go b/test/e2e/atlas/autogeneration/autogeneratedcommands/autogenerated_commands_test.go index 9465545068..41a87302f6 100644 --- a/test/e2e/atlas/autogeneration/autogeneratedcommands/autogenerated_commands_test.go +++ b/test/e2e/atlas/autogeneration/autogeneratedcommands/autogenerated_commands_test.go @@ -37,8 +37,8 @@ func TestAutogeneratedCommands(t *testing.T) { req := require.New(t) req.NoError(err) - t.Run("getCluster_RequiredFieldNotSet", func(_ *testing.T) { - cmd := exec.Command(cliPath, "api", "clusters", "getCluster", "-P", internal.ProfileName()) + t.Run("getGroupCluster_RequiredFieldNotSet", func(_ *testing.T) { + cmd := exec.Command(cliPath, "api", "clusters", "getGroupCluster", "-P", internal.ProfileName()) cmd.Env = os.Environ() _, err := internal.RunAndGetStdOutAndErr(cmd) @@ -52,8 +52,8 @@ func TestAutogeneratedCommands(t *testing.T) { Name string `json:"name"` } - t.Run("getCluster_OK", func(_ *testing.T) { - cmd := exec.Command(cliPath, "api", "clusters", "getCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "-P", internal.ProfileName()) + t.Run("getGroupCluster_OK", func(_ *testing.T) { + cmd := exec.Command(cliPath, "api", "clusters", "getGroupCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "-P", internal.ProfileName()) cmd.Env = os.Environ() stdOut, stdErr, err := internal.RunAndGetSeparateStdOutAndErr(cmd) @@ -70,8 +70,8 @@ func TestAutogeneratedCommands(t *testing.T) { req.Contains(errorStr, "'; consider pinning a version to ensure consisentcy when updating the CLI\n") }) - t.Run("getCluster_valid_version_OK", func(_ *testing.T) { - cmd := exec.Command(cliPath, "api", "clusters", "getCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2024-08-05", "-P", internal.ProfileName()) + t.Run("getGroupCluster_valid_version_OK", func(_ *testing.T) { + cmd := exec.Command(cliPath, "api", "clusters", "getGroupCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2024-08-05", "-P", internal.ProfileName()) cmd.Env = os.Environ() stdOut, stdErr, err := internal.RunAndGetSeparateStdOutAndErr(cmd) @@ -88,8 +88,8 @@ func TestAutogeneratedCommands(t *testing.T) { req.NotContains(errorStr, "'; consider pinning a version to ensure consisentcy when updating the CLI\n") }) - t.Run("getCluster_valid_version_OK_using_projectID_alias", func(_ *testing.T) { - cmd := exec.Command(cliPath, "api", "clusters", "getCluster", "--projectId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2024-08-05", "-P", internal.ProfileName()) + t.Run("getGroupCluster_valid_version_OK_using_projectID_alias", func(_ *testing.T) { + cmd := exec.Command(cliPath, "api", "clusters", "getGroupCluster", "--projectId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2024-08-05", "-P", internal.ProfileName()) cmd.Env = os.Environ() stdOut, stdErr, err := internal.RunAndGetSeparateStdOutAndErr(cmd) @@ -106,8 +106,8 @@ func TestAutogeneratedCommands(t *testing.T) { req.NotContains(errorStr, "'; consider pinning a version to ensure consisentcy when updating the CLI\n") }) - t.Run("getCluster_invalid_version_warn", func(_ *testing.T) { - cmd := exec.Command(cliPath, "api", "clusters", "getCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2020-01-01", "-P", internal.ProfileName()) + t.Run("getGroupCluster_invalid_version_warn", func(_ *testing.T) { + cmd := exec.Command(cliPath, "api", "clusters", "getGroupCluster", "--groupId", g.ProjectID, "--clusterName", g.ClusterName, "--version", "2020-01-01", "-P", internal.ProfileName()) cmd.Env = os.Environ() stdOut, stdErr, err := internal.RunAndGetSeparateStdOutAndErr(cmd) diff --git a/test/internal/helper.go b/test/internal/helper.go index 892a2185e7..e8f7bbbacc 100644 --- a/test/internal/helper.go +++ b/test/internal/helper.go @@ -1512,7 +1512,7 @@ func createOrgServiceAccount(cliPath, name string) (string, string, error) { args := []string{ apiEntity, serviceAccountsEntity, - "createServiceAccount", + "createOrgServiceAccount", "--version", serviceAccountAPIVersion, "-P", @@ -1564,7 +1564,7 @@ func deleteOrgServiceAccount(t *testing.T, cliPath, clientID string) { args := []string{ apiEntity, serviceAccountsEntity, - "deleteServiceAccount", + "deleteOrgServiceAccount", "--clientId", clientID, "--version", diff --git a/tools/cmd/docs/metadata.go b/tools/cmd/docs/metadata.go index 79f5b87696..f3ef1c6249 100644 --- a/tools/cmd/docs/metadata.go +++ b/tools/cmd/docs/metadata.go @@ -20,7 +20,7 @@ package main import "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/internal/metadatatypes" var metadata = metadatatypes.Metadata{ - `acceptVpcPeeringConnection`: { + `acceptGroupStreamVpcPeeringConnection`: { 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.`, @@ -36,7 +36,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `acknowledgeAlert`: { + `acknowledgeGroupAlert`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `alertId`: { Usage: `Unique 24-hexadecimal digit string that identifies the alert.`, @@ -55,7 +55,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `addAllTeamsToProject`: { + `addGroupAccessUser`: { 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.`, @@ -71,24 +71,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `addOrganizationRole`: { - 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.`, - }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, - }, - }, - Examples: nil, - }, - `addProjectApiKey`: { + `addGroupApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `apiUserId`: { Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.`, @@ -107,7 +90,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `addProjectRole`: { + `addGroupTeams`: { 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.`, @@ -120,17 +103,11 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, - }, }, Examples: nil, }, - `addProjectServiceAccount`: { + `addGroupUserRole`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -142,10 +119,13 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, + }, }, Examples: nil, }, - `addProjectUser`: { + `addGroupUsers`: { 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.`, @@ -161,7 +141,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `addTeamUser`: { + `addOrgTeamUser`: { 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.`, @@ -173,28 +153,29 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, `teamId`: { - Usage: `Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.`, + Usage: `Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.`, }, }, Examples: nil, }, - `addUserToProject`: { + `addOrgTeamUsers`: { 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.`, + `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.`, }, + `teamId`: { + Usage: `Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.`, + }, }, Examples: nil, }, - `addUserToTeam`: { + `addOrgUserRole`: { 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.`, @@ -205,13 +186,13 @@ var metadata = metadatatypes.Metadata{ `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 to add the MongoDB Cloud user to.`, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, }, }, Examples: nil, }, - `authorizeCloudProviderAccessRole`: { + `authorizeGroupCloudProviderAccessRole`: { 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.`, @@ -230,7 +211,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `autoScalingConfiguration`: { + `autoGroupClusterScalingConfiguration`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies this cluster.`, @@ -259,7 +240,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `cancelBackupRestoreJob`: { + `cancelGroupClusterBackupRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -292,67 +273,64 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `createAlertConfiguration`: { + `createFederationSettingConnectedOrgConfigRoleMapping`: { 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.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `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.`, }, }, Examples: nil, }, - `createApiKey`: { + `createFederationSettingIdentityProvider`: { 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.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, }, }, Examples: nil, }, - `createApiKeyAccessList`: { + `createGroup`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.`, - }, `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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `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.`, + `projectOwnerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `create_project`, + Name: `Create a basic project with environment tag`, + Description: `Creates a new project named "MongoTube" with an environment tag set to "e2e"`, + Value: `{ + "name": "MongoTube", + "orgId": "67b715468c10250b968dcb84", + "tags": [ + { + "key": "environment", + "value": "e2e" + } + ] +}`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, }, - `createAtlasSearchDeployment`: { + `createGroupAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Label that identifies the cluster to create Search Nodes for.`, - }, `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.`, }, @@ -361,17 +339,43 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `project_ip_access_list_add`, + Name: `Add Entries to Project IP Access List`, + Description: `Adds multiple access list entries to the specified project`, + Value: `[ + { + "cidrBlock": "192.168.1.0/24", + "comment": "Internal network range" + }, + { + "cidrBlock": "10.0.0.0/16", + "comment": "VPC network range" + } +]`, + Flags: map[string]string{ + `groupId`: `[your-project-id]`, + }, + }, + }, + }, }, - `createAtlasSearchIndex`: { + `createGroupAlertConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, - }, `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.`, }, @@ -386,11 +390,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createAtlasSearchIndexDeprecated`: { + `createGroupApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, - }, `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.`, }, @@ -405,11 +406,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createBackupExportJob`: { + `createGroupBackupExportBucket`: { 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.`, }, @@ -418,29 +416,69 @@ var metadata = metadatatypes.Metadata{ **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.`, + }, }, - Examples: nil, - }, - `createBackupRestoreJob`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `AWS`, + + Description: `AWS`, + Value: `{ + "bucketName": "export-bucket", + "cloudProvider": "AWS", + "iamRoleId": "668c5f0ed436263134491592", + "requirePrivateNetworking": false +}`, + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `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. + `2024-05-30`: {{ + Source: `AWS`, -**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.`, + Description: `AWS`, + Value: `{ + "bucketName": "export-bucket", + "cloudProvider": "AWS", + "iamRoleId": "668c5f0ed436263134491592", + "requirePrivateNetworking": false +}`, + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, { + Source: `Azure`, + + Description: `Azure`, + Value: `{ + "bucketName": "examplecontainer", + "cloudProvider": "AZURE", + "roleId": "668c5f0ed436263134491592", + "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" +}`, + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, { + Source: `GCP`, + + Description: `GCP`, + Value: `{ + "bucketName": "export-bucket", + "cloudProvider": "GCP", + "roleId": "668c5f0ed436263134491592" +}`, + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, }, - `createCloudProviderAccessRole`: { + `createGroupCloudProviderAccess`: { 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.`, @@ -456,7 +494,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createCluster`: { + `createGroupCluster`: { 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.`, @@ -730,19 +768,65 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `createCostExplorerQueryProcess`: { + `createGroupClusterBackupExport`: { 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.`, }, - `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.`, + `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.`, + }, + }, + Examples: nil, + }, + `createGroupClusterBackupRestoreJob`: { + 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.`, + }, + }, + Examples: nil, + }, + `createGroupClusterBackupTenantRestore`: { + 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.`, }, }, Examples: nil, }, - `createCustomDatabaseRole`: { + `createGroupClusterFtsIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, + }, `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.`, }, @@ -757,7 +841,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createCustomZoneMapping`: { + `createGroupClusterGlobalWriteCustomZoneMapping`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies this cluster.`, @@ -776,8 +860,11 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createDataFederationPrivateEndpoint`: { + `createGroupClusterGlobalWriteManagedNamespace`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, }, @@ -792,8 +879,11 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createDatabaseUser`: { + `createGroupClusterIndexRollingIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.`, + }, `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.`, }, @@ -808,9 +898,259 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `AWS IAM Authentication`, + Source: `2dspere Index`, - Description: `AWS IAM Authentication`, + Description: `2dspere Index`, + Value: `{ + "collation": { + "alternate": "non-ignorable", + "backwards": false, + "caseFirst": "lower", + "caseLevel": false, + "locale": "af", + "maxVariable": "punct", + "normalization": false, + "numericOrdering": false, + "strength": 3 + }, + "collection": "accounts", + "db": "sample_airbnb", + "keys": [ + { + "property_type": "1" + } + ], + "options": { + "name": "PartialIndexTest", + "partialFilterExpression": { + "limit": { + "$gt": 900 + } + } + } +}`, + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, { + Source: `Partial Index`, + + Description: `Partial Index`, + Value: `{ + "collation": { + "alternate": "non-ignorable", + "backwards": false, + "caseFirst": "lower", + "caseLevel": false, + "locale": "af", + "maxVariable": "punct", + "normalization": false, + "numericOrdering": false, + "strength": 3 + }, + "collection": "accounts", + "db": "sample_airbnb", + "keys": [ + { + "property_type": "1" + } + ], + "options": { + "name": "PartialIndexTest", + "partialFilterExpression": { + "limit": { + "$gt": 900 + } + } + } +}`, + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, { + Source: `Sparse Index`, + + Description: `Sparse Index`, + Value: `{ + "collation": { + "alternate": "non-ignorable", + "backwards": false, + "caseFirst": "lower", + "caseLevel": false, + "locale": "af", + "maxVariable": "punct", + "normalization": false, + "numericOrdering": false, + "strength": 3 + }, + "collection": "accounts", + "db": "sample_airbnb", + "keys": [ + { + "test_field": "1" + } + ], + "options": { + "name": "SparseIndexTest", + "sparse": true + } +}`, + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, + `createGroupClusterOnlineArchive`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.`, + }, + `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.`, + }, + }, + Examples: nil, + }, + `createGroupClusterRestoreJob`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + }, + `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.`, + }, + }, + Examples: nil, + }, + `createGroupClusterSearchDeployment`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Label that identifies the cluster to create Search Nodes for.`, + }, + `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.`, + }, + }, + Examples: nil, + }, + `createGroupClusterSearchIndex`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection on which to create an Atlas Search index.`, + }, + `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.`, + }, + }, + Examples: nil, + }, + `createGroupContainer`: { + 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.`, + }, + }, + Examples: nil, + }, + `createGroupCustomDbRoleRole`: { + 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.`, + }, + }, + Examples: nil, + }, + `createGroupDataFederation`: { + 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.`, + }, + `skipRoleValidation`: { + Usage: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, + }, + }, + Examples: nil, + }, + `createGroupDatabaseUser`: { + 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.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `AWS IAM Authentication`, + + Description: `AWS IAM Authentication`, Value: `{ "awsIAMType": "USER", "databaseName": "$external", @@ -936,155 +1276,47 @@ var metadata = metadatatypes.Metadata{ "databaseName": "sales", "roleName": "readWrite" }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "david" -}`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, { - Source: `X509 Authentication`, - - Description: `X509 Authentication`, - Value: `{ - "databaseName": "$external", - "groupId": "32b6e34b3d91647abb20e7b8", - "roles": [ - { - "databaseName": "sales", - "roleName": "readWrite" - }, - { - "databaseName": "marketing", - "roleName": "read" - } - ], - "scopes": [ - { - "name": "myCluster", - "type": "CLUSTER" - } - ], - "username": "CN=david@example.com,OU=users,DC=example,DC=com", - "x509Type": "CUSTOMER" -}`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, - `createDatabaseUserCertificate`: { - 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.`, - }, - `username`: { - Usage: `Human-readable label that represents the MongoDB database user account for whom to create a certificate.`, - }, - }, - Examples: nil, - }, - `createEncryptionAtRestPrivateEndpoint`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Human-readable label that identifies the cloud provider for the private endpoint to create.`, - }, - `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.`, - }, - }, - Examples: nil, - }, - `createExportBucket`: { - 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.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `AWS`, - - Description: `AWS`, - Value: `{ - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592" -}`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - `2024-05-30`: {{ - Source: `AWS`, - - Description: `AWS`, - Value: `{ - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592" -}`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, { - Source: `Azure`, - - Description: `Azure`, - Value: `{ - "bucketName": "examplecontainer", - "cloudProvider": "AZURE", - "roleId": "668c5f0ed436263134491592", - "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" + { + "databaseName": "marketing", + "roleName": "read" + } + ], + "scopes": [ + { + "name": "myCluster", + "type": "CLUSTER" + } + ], + "username": "david" }`, Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, { - Source: `GCP`, + Source: `X509 Authentication`, - Description: `GCP`, + Description: `X509 Authentication`, Value: `{ - "bucketName": "export-bucket", - "cloudProvider": "GCP", - "roleId": "668c5f0ed436263134491592" + "databaseName": "$external", + "groupId": "32b6e34b3d91647abb20e7b8", + "roles": [ + { + "databaseName": "sales", + "roleName": "readWrite" + }, + { + "databaseName": "marketing", + "roleName": "read" + } + ], + "scopes": [ + { + "name": "myCluster", + "type": "CLUSTER" + } + ], + "username": "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type": "CUSTOMER" }`, Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, @@ -1093,7 +1325,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `createFederatedDatabase`: { + `createGroupDatabaseUserCert`: { 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.`, @@ -1106,14 +1338,17 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `skipRoleValidation`: { - Usage: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, + `username`: { + Usage: `Human-readable label that represents the MongoDB database user account for whom to create a certificate.`, }, }, Examples: nil, }, - `createFlexBackupRestoreJob`: { + `createGroupEncryptionAtRestPrivateEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `Human-readable label that identifies the cloud provider for the private endpoint to create.`, + }, `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.`, }, @@ -1122,16 +1357,13 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster whose snapshot you want to restore.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `createFlexCluster`: { + `createGroupFlexCluster`: { 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.`, @@ -1147,22 +1379,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createIdentityProvider`: { - 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.`, - }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - }, - Examples: nil, - }, - `createLegacyBackupRestoreJob`: { + `createGroupFlexClusterBackupRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, - }, `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.`, }, @@ -1171,19 +1389,8 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - }, - Examples: nil, - }, - `createLinkToken`: { - 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.`, + `name`: { + Usage: `Human-readable label that identifies the flex cluster whose snapshot you want to restore.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -1191,11 +1398,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createManagedNamespace`: { + `createGroupIntegration`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this 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.`, }, @@ -1204,44 +1408,26 @@ var metadata = metadatatypes.Metadata{ **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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - }, - Examples: nil, - }, - `createOneDataFederationQueryLimit`: { - 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.`, + `integrationType`: { + Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, }, - `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.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `limitName`: { - Usage: `Human-readable label that identifies this data federation instance limit. - -| Limit Name | Description | Default | -| --- | --- | --- | -| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | -| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | -| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | -| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | -`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `createOnlineArchive`: { + `createGroupInvite`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.`, - }, `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.`, }, @@ -1256,60 +1442,7 @@ 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`: { - 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.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: nil, - }, - `createOrganizationInvitation`: { - 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, - }, - `createOrganizationUser`: { - 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, - }, - `createPeeringConnection`: { + `createGroupLiveMigration`: { 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.`, @@ -1325,7 +1458,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createPeeringContainer`: { + `createGroupPeer`: { 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.`, @@ -1341,7 +1474,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createPipeline`: { + `createGroupPipeline`: { 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.`, @@ -1354,14 +1487,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createPrivateEndpoint`: { + `createGroupPrivateEndpointEndpointService`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint.`, - }, - `endpointServiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.`, - }, `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.`, }, @@ -1376,24 +1503,14 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createPrivateEndpointService`: { + `createGroupPrivateEndpointEndpointServiceEndpoint`: { 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.`, + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `endpointServiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.`, }, - }, - Examples: nil, - }, - `createPrivateLinkConnection`: { - 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.`, }, @@ -1408,38 +1525,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createProject`: { - 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.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - `projectOwnerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `create_project`, - Name: `Create a basic project with environment tag`, - Description: `Creates a new project named "MongoTube" with an environment tag set to "e2e"`, - Value: `{ - "name": "MongoTube", - "orgId": "67b715468c10250b968dcb84", - "tags": [ - { - "key": "environment", - "value": "e2e" - } - ] -}`, - }, - }, - }, - }, - `createProjectApiKey`: { + `createGroupPrivateEndpointServerlessInstanceEndpoint`: { 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.`, @@ -1449,13 +1535,13 @@ var metadata = metadatatypes.Metadata{ **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.`, + `instanceName`: { + Usage: `Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.`, }, }, Examples: nil, }, - `createProjectInvitation`: { + `createGroupPrivateNetworkSettingEndpointId`: { 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.`, @@ -1471,7 +1557,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createProjectIpAccessList`: { + `createGroupPushBasedLogExport`: { 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.`, @@ -1481,43 +1567,17 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `project_ip_access_list_add`, - Name: `Add Entries to Project IP Access List`, - Description: `Adds multiple access list entries to the specified project`, - Value: `[ - { - "cidrBlock": "192.168.1.0/24", - "comment": "Internal network range" - }, - { - "cidrBlock": "10.0.0.0/16", - "comment": "VPC network range" - } -]`, - Flags: map[string]string{ - `groupId`: `[your-project-id]`, - }, - }, - }, - }, + Examples: nil, }, - `createProjectServiceAccount`: { + `createGroupServerlessBackupRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the serverless instance whose snapshot you want to restore.`, + }, `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.`, }, @@ -1532,11 +1592,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createProjectServiceAccountAccessList`: { + `createGroupServerlessInstance`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -1545,26 +1602,14 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `createProjectServiceAccountSecret`: { + `createGroupServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -1579,8 +1624,11 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createPushBasedLogConfiguration`: { + `createGroupServiceAccountAccessList`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -1589,14 +1637,26 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `createPushMigration`: { + `createGroupServiceAccountSecret`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -1611,25 +1671,27 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createRoleMapping`: { + `createGroupStreamConnection`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, }, - `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.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: nil, }, - `createRollingIndex`: { + `createGroupStreamPrivateLinkConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.`, - }, `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.`, }, @@ -1642,120 +1704,10 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `2dspere Index`, - - Description: `2dspere Index`, - Value: `{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "property_type": "1" - } - ], - "options": { - "name": "PartialIndexTest", - "partialFilterExpression": { - "limit": { - "$gt": 900 - } - } - } -}`, - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, { - Source: `Partial Index`, - - Description: `Partial Index`, - Value: `{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "property_type": "1" - } - ], - "options": { - "name": "PartialIndexTest", - "partialFilterExpression": { - "limit": { - "$gt": 900 - } - } - } -}`, - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, { - Source: `Sparse Index`, - - Description: `Sparse Index`, - Value: `{ - "collation": { - "alternate": "non-ignorable", - "backwards": false, - "caseFirst": "lower", - "caseLevel": false, - "locale": "af", - "maxVariable": "punct", - "normalization": false, - "numericOrdering": false, - "strength": 3 - }, - "collection": "accounts", - "db": "sample_airbnb", - "keys": [ - { - "test_field": "1" - } - ], - "options": { - "name": "SparseIndexTest", - "sparse": true - } -}`, - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, + Examples: nil, }, - `createServerlessBackupRestoreJob`: { + `createGroupStreamProcessor`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the serverless instance whose snapshot you want to restore.`, - }, `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.`, }, @@ -1767,10 +1719,13 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, + }, }, Examples: nil, }, - `createServerlessInstance`: { + `createGroupStreamWorkspace`: { 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.`, @@ -1786,23 +1741,18 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createServerlessPrivateEndpoint`: { + `createOrg`: { 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.`, - }, - `instanceName`: { - Usage: `Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `createServiceAccount`: { + `createOrgApiKey`: { 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.`, @@ -1816,10 +1766,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createServiceAccountAccessList`: { + `createOrgApiKeyAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.`, }, `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.`, @@ -1842,35 +1792,24 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createServiceAccountSecret`: { + `createOrgBillingCostExplorerUsageProcess`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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, }, - `createSharedClusterBackupRestoreJob`: { + `createOrgInvite`: { 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.`, + `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.`, @@ -1878,34 +1817,27 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createStreamConnection`: { + `createOrgLiveMigrationLinkToken`: { 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.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: nil, }, - `createStreamInstance`: { + `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.`, }, - `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.`, + `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.`, @@ -1913,15 +1845,13 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createStreamInstanceWithSampleConnections`: { + `createOrgServiceAccount`: { 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.`, + `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.`, @@ -1929,27 +1859,37 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createStreamProcessor`: { + `createOrgServiceAccountAccessList`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `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.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: nil, }, - `createTeam`: { + `createOrgServiceAccountSecret`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -1962,27 +1902,27 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createThirdPartyIntegration`: { + `createOrgTeam`: { 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.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + `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.`, }, - `integrationType`: { - Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + }, + Examples: nil, + }, + `createOrgUser`: { + 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.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, @@ -2001,7 +1941,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `cutoverMigration`: { + `cutoverGroupLiveMigration`: { 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.`, @@ -2030,7 +1970,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deauthorizeCloudProviderAccessRole`: { + `deauthorizeGroupCloudProviderAccessRole`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `cloudProvider`: { Usage: `Human-readable label that identifies the cloud provider of the role to deauthorize.`, @@ -2063,7 +2003,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deferMaintenanceWindow`: { + `deferGroupMaintenanceWindow`: { 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.`, @@ -2085,11 +2025,77 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteAlertConfiguration`: { + `deleteFederationSetting`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `alertConfigId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + }, + }, + }, + }, + }, + `deleteFederationSettingConnectedOrgConfigRoleMapping`: { + 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `id`: { + Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.`, + }, + `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.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + `id`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, + }, + }, + }, + }, + }, + `deleteFederationSettingIdentityProvider`: { + 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `identityProviderId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the identity provider to connect.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-11-15`: {{ + Source: `-`, + + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + }, }, + }, + }, + }, + `deleteGroup`: { + 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.`, }, @@ -2104,20 +2110,25 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `-`, + Source: `delete_project`, + Name: `Delete a project`, + Description: `Deletes an existing project`, Flags: map[string]string{ - `alertConfigId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteAllBackupSchedules`: { + `deleteGroupAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `entryValue`: { + Usage: `Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (` + "`" + `/` + "`" + `) with its URL-encoded value (` + "`" + `%2F` + "`" + `). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: + +- how your application established the connection, +- how MongoDB Cloud or the driver using the address behaves, and +- which protocol (like TCP or UDP) the connection uses.`, }, `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.`, @@ -2127,23 +2138,28 @@ var metadata = metadatatypes.Metadata{ **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.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, + `2023-01-01`: {{ + Source: `project_ip_access_list_delete`, + Name: `Remove One Entry from One Project IP Access List`, + Description: `Removes one access list entry from the specified project's IP access list`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `entryValue`: `10.0.0.0/16`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `deleteAllCustomZoneMappings`: { + `deleteGroupAlertConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this cluster.`, + `alertConfigId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, }, `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.`, @@ -2158,30 +2174,29 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `alertConfigId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteApiKey`: { + `deleteGroupBackupExportBucket`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key.`, - }, `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.`, + `exportBucketId`: { + Usage: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2189,48 +2204,51 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `orgId`: `4888442a3354817a7320eb61`, + `exportBucketId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteApiKeyAccessListEntry`: { + `deleteGroupCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.`, + `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.`, }, - `ipAddress`: { - Usage: `One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, - }, - `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.`, + `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.`, }, + `retainBackups`: { + Usage: `Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, + `2023-02-01`: {{ + Source: `delete_cluster`, + Name: `Delete a cluster`, + Description: `Deletes the specified cluster from the project`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `ipAddress`: `192.0.2.0%2F24`, - `orgId`: `4888442a3354817a7320eb61`, + `clusterName`: `[your-cluster-name]`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `deleteAtlasSearchDeployment`: { + `deleteGroupClusterBackupSchedule`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Label that identifies the cluster to delete.`, + 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.`, @@ -2240,12 +2258,9 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ @@ -2256,10 +2271,10 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteAtlasSearchIndex`: { + `deleteGroupClusterBackupSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, + 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.`, @@ -2269,36 +2284,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `indexId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ `clusterName`: `[clusterName]`, `groupId`: `32b6e34b3d91647abb20e7b8`, - `indexId`: `[indexId]`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `deleteAtlasSearchIndexByName`: { + `deleteGroupClusterBackupSnapshotShardedCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, - }, - `collectionName`: { - Usage: `Name of the collection that contains one or more Atlas Search indexes.`, - }, - `databaseName`: { - Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + 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.`, @@ -2308,29 +2317,27 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `indexName`: { - Usage: `Name of the Atlas Search index to delete.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `collectionName`: `[collectionName]`, - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `indexName`: `[indexName]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `deleteAtlasSearchIndexDeprecated`: { + `deleteGroupClusterFtsIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, @@ -2363,10 +2370,10 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteCluster`: { + `deleteGroupClusterGlobalWriteCustomZoneMapping`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + Usage: `Human-readable label that identifies this 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.`, @@ -2379,26 +2386,30 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `retainBackups`: { - Usage: `Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ - Source: `delete_cluster`, - Name: `Delete a cluster`, - Description: `Deletes the specified cluster from the project`, + `2024-08-05`: {{ + Source: `-`, Flags: map[string]string{ - `clusterName`: `[your-cluster-name]`, - `groupId`: `[your-project-id]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteCustomDatabaseRole`: { + `deleteGroupClusterGlobalWriteManagedNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this cluster.`, + }, + `collection`: { + Usage: `Human-readable label that identifies the collection associated with the managed namespace.`, + }, + `db`: { + Usage: `Human-readable label that identifies the database that contains the collection.`, + }, `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.`, }, @@ -2410,26 +2421,56 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `roleName`: { - Usage: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2024-08-05`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, + `deleteGroupClusterOnlineArchive`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `archiveId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the online archive to delete.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.`, + }, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `roleName`: `[roleName]`, + Flags: map[string]string{ + `archiveId`: `[archiveId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteDataFederationPrivateEndpoint`: { + `deleteGroupClusterSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endpointId`: { - Usage: `Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, + `clusterName`: { + Usage: `Label that identifies the cluster to delete.`, }, `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.`, @@ -2448,17 +2489,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `endpointId`: `[endpointId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteDatabaseUser`: { + `deleteGroupClusterSearchIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `databaseName`: { - Usage: `The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be ` + "`" + `$external` + "`" + `. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be ` + "`" + `admin` + "`" + `.`, + `clusterName`: { + Usage: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, }, `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.`, @@ -2468,67 +2509,72 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `indexId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `username`: { - Usage: `Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: - -| Authentication Method | Parameter Needed | Parameter Value | username Format | -|---|---|---|---| -| AWS IAM | awsIAMType | ROLE | ARN | -| AWS IAM | awsIAMType | USER | ARN | -| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | -| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | -| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | -`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `username`: `SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `indexId`: `[indexId]`, }, }, }, }, }, - `deleteExportBucket`: { + `deleteGroupClusterSearchIndexByName`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the database and collection with one or more Application Search indexes.`, + }, + `collectionName`: { + Usage: `Name of the collection that contains one or more Atlas Search indexes.`, + }, + `databaseName`: { + Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + }, `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.`, }, - `exportBucketId`: { - Usage: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, - }, `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.`, }, + `indexName`: { + Usage: `Name of the Atlas Search index to delete.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `exportBucketId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `collectionName`: `[collectionName]`, + `databaseName`: `[databaseName]`, `groupId`: `32b6e34b3d91647abb20e7b8`, + `indexName`: `[indexName]`, }, }, }, }, }, - `deleteFederatedDatabase`: { + `deleteGroupClusterSnapshot`: { 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.`, }, @@ -2540,8 +2586,8 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance to remove.`, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2549,17 +2595,29 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `deleteFederationApp`: { + `deleteGroupContainer`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `containerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, + }, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2567,13 +2625,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, + `containerId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteFlexCluster`: { + `deleteGroupCustomDbRoleRole`: { 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.`, @@ -2583,50 +2642,55 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `roleName`: { + Usage: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `roleName`: `[roleName]`, }, }, }, }, }, - `deleteIdentityProvider`: { + `deleteGroupDataFederation`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, }, - `identityProviderId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the identity provider to connect.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance to remove.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `deleteLdapConfiguration`: { + `deleteGroupDataFederationLimit`: { 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.`, @@ -2636,8 +2700,19 @@ var metadata = metadatatypes.Metadata{ **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.`, + `limitName`: { + Usage: `Human-readable label that identifies this data federation instance limit. + +| Limit Name | Description | Default | +| --- | --- | --- | +| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | +| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | +| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | +| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | +`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2645,16 +2720,18 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `limitName`: `[limitName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `deleteLegacySnapshot`: { + `deleteGroupDatabaseUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `databaseName`: { + Usage: `The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be ` + "`" + `$external` + "`" + `. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be ` + "`" + `admin` + "`" + `.`, }, `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.`, @@ -2667,8 +2744,21 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `username`: { + Usage: `Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: + +| Authentication Method | Parameter Needed | Parameter Value | username Format | +|---|---|---|---| +| AWS IAM | awsIAMType | ROLE | ARN | +| AWS IAM | awsIAMType | USER | ARN | +| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | +| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | +| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | +`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2676,45 +2766,45 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `username`: `SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName`, }, }, }, }, }, - `deleteLinkToken`: { + `deleteGroupFlexCluster`: { 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.`, + `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.`, + }, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `deleteManagedNamespace`: { + `deleteGroupIntegration`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this cluster.`, - }, - `collection`: { - Usage: `Human-readable label that identifies the collection associated with the managed namespace.`, - }, - `db`: { - Usage: `Human-readable label that identifies the database that contains the collection.`, - }, `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.`, }, @@ -2723,23 +2813,26 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `integrationType`: { + Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `integrationType`: `[integrationType]`, }, }, }, }, }, - `deleteOneDataFederationInstanceQueryLimit`: { + `deleteGroupInvite`: { 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.`, @@ -2749,19 +2842,8 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `limitName`: { - Usage: `Human-readable label that identifies this data federation instance limit. - -| Limit Name | Description | Default | -| --- | --- | --- | -| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | -| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | -| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | -| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | -`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2769,22 +2851,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `limitName`: `[limitName]`, - `tenantName`: `[tenantName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `invitationId`: `[invitationId]`, }, }, }, }, }, - `deleteOnlineArchive`: { + `deleteGroupLimit`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `archiveId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the online archive to delete.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.`, - }, `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.`, }, @@ -2792,6 +2867,25 @@ var metadata = metadatatypes.Metadata{ 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.`, + }, + `limitName`: { + Usage: `Human-readable label that identifies this project limit. + +| Limit Name | Description | Default | API Override Limit | +| --- | --- | --- | --- | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | +| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | +| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | +| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | +| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | +| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | +| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | +| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | +| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | +| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| +`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -2802,48 +2896,54 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `archiveId`: `[archiveId]`, - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `limitName`: `[limitName]`, }, }, }, }, }, - `deleteOrgResourcePolicy`: { + `deleteGroupPeer`: { 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.`, + `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.`, + }, + `peerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.`, }, `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`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `peerId`: `[peerId]`, }, }, }, }, }, - `deleteOrganization`: { + `deleteGroupPipeline`: { 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.`, + `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.`, + }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2851,22 +2951,28 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, }, }, }, }, }, - `deleteOrganizationInvitation`: { + `deleteGroupPipelineRun`: { 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.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + `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.`, }, - `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.`, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, + `pipelineRunId`: { + Usage: `Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -2877,15 +2983,22 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `invitationId`: `[invitationId]`, - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, + `pipelineRunId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deletePeeringConnection`: { + `deleteGroupPrivateEndpointEndpointService`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint service.`, + }, + `endpointServiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.`, + }, `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.`, }, @@ -2894,9 +3007,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `peerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -2906,17 +3016,24 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `peerId`: `[peerId]`, + `cloudProvider`: `[cloudProvider]`, + `endpointServiceId`: `[endpointServiceId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deletePeeringContainer`: { + `deleteGroupPrivateEndpointEndpointServiceEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `containerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint.`, + }, + `endpointId`: { + Usage: `Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.`, + }, + `endpointServiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.`, }, `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.`, @@ -2935,15 +3052,20 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `containerId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `cloudProvider`: `[cloudProvider]`, + `endpointId`: `[endpointId]`, + `endpointServiceId`: `[endpointServiceId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deletePipeline`: { + `deleteGroupPrivateEndpointServerlessInstanceEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endpointId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.`, + }, `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.`, }, @@ -2952,8 +3074,8 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + `instanceName`: { + Usage: `Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -2961,15 +3083,19 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ + `endpointId`: `[endpointId]`, `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, + `instanceName`: `[instanceName]`, }, }, }, }, }, - `deletePipelineRunDataset`: { + `deleteGroupPrivateNetworkSettingEndpointId`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endpointId`: { + Usage: `Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, + }, `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.`, }, @@ -2978,12 +3104,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, - }, - `pipelineRunId`: { - Usage: `Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -2993,25 +3113,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, - `pipelineRunId`: `32b6e34b3d91647abb20e7b8`, + `endpointId`: `[endpointId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deletePrivateEndpoint`: { + `deleteGroupPushBasedLogExport`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint.`, - }, - `endpointId`: { - Usage: `Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.`, - }, - `endpointServiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.`, - }, `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.`, }, @@ -3029,23 +3139,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `endpointId`: `[endpointId]`, - `endpointServiceId`: `[endpointServiceId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deletePrivateEndpointService`: { + `deleteGroupServerlessInstance`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint service.`, - }, - `endpointServiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.`, - }, `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.`, }, @@ -3054,6 +3155,9 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `name`: { + Usage: `Human-readable label that identifies the serverless instance.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -3063,18 +3167,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `endpointServiceId`: `[endpointServiceId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `deletePrivateLinkConnection`: { + `deleteGroupServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `connectionId`: { - Usage: `Unique ID that identifies the Private Link connection.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, @@ -3089,19 +3192,22 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `connectionId`: `[connectionId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteProject`: { + `deleteGroupServiceAccountAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -3110,25 +3216,31 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `ipAddress`: { + Usage: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `delete_project`, - Name: `Delete a project`, - Description: `Deletes an existing project`, + `2024-08-05`: {{ + Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `ipAddress`: `192.0.2.0%2F24`, }, }, }, }, }, - `deleteProjectInvitation`: { + `deleteGroupServiceAccountSecret`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -3137,30 +3249,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `secretId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the secret.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `invitationId`: `[invitationId]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `secretId`: `[secretId]`, }, }, }, }, }, - `deleteProjectIpAccessList`: { + `deleteGroupStreamConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `entryValue`: { - Usage: `Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (` + "`" + `/` + "`" + `) with its URL-encoded value (` + "`" + `%2F` + "`" + `). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: - -- how your application established the connection, -- how MongoDB Cloud or the driver using the address behaves, and -- which protocol (like TCP or UDP) the connection uses.`, + `connectionName`: { + Usage: `Human-readable label that identifies the stream connection.`, }, `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.`, @@ -3173,23 +3285,28 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `project_ip_access_list_delete`, - Name: `Remove One Entry from One Project IP Access List`, - Description: `Removes one access list entry from the specified project's IP access list`, + `2023-02-01`: {{ + Source: `-`, Flags: map[string]string{ - `entryValue`: `10.0.0.0/16`, - `groupId`: `[your-project-id]`, + `connectionName`: `[connectionName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `deleteProjectLimit`: { + `deleteGroupStreamPrivateLinkConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `connectionId`: { + Usage: `Unique ID that identifies the Private Link connection.`, + }, `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.`, }, @@ -3197,48 +3314,25 @@ var metadata = metadatatypes.Metadata{ 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.`, - }, - `limitName`: { - Usage: `Human-readable label that identifies this project limit. - -| Limit Name | Description | Default | API Override Limit | -| --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | -| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | -| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | -| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | -| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | -| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | -| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | -| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | -| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | -| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | -`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `limitName`: `[limitName]`, + `connectionId`: `[connectionId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteProjectServiceAccount`: { + `deleteGroupStreamProcessor`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -3250,24 +3344,28 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processorName`: `[processorName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `deleteProjectServiceAccountAccessListEntry`: { + `deleteGroupStreamVpcPeeringConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -3276,31 +3374,24 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `ipAddress`: { - Usage: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `id`: { + Usage: `The VPC Peering Connection id.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-02-01`: {{ Source: `-`, - Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `ipAddress`: `192.0.2.0%2F24`, + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + `id`: `[id]`, }, }, }, }, }, - `deleteProjectServiceAccountSecret`: { + `deleteGroupStreamWorkspace`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -3312,24 +3403,23 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `secretId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the secret.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance to delete.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `secretId`: `[secretId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `deletePushBasedLogConfiguration`: { + `deleteGroupUserSecurityLdapUserToDnMapping`: { 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.`, @@ -3354,24 +3444,13 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteReplicaSetBackup`: { + `deleteOrg`: { 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.`, - }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -3379,54 +3458,52 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteRoleMapping`: { + `deleteOrgApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key.`, + }, `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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `id`: { - Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.`, - }, `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{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `id`: `32b6e34b3d91647abb20e7b8`, - `orgId`: `4888442a3354817a7320eb61`, + `apiUserId`: `[apiUserId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteServerlessInstance`: { + `deleteOrgApiKeyAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.`, + }, `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.`, + `ipAddress`: { + Usage: `One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, }, - `name`: { - Usage: `Human-readable label that identifies the serverless instance.`, + `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.`, @@ -3437,28 +3514,27 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `apiUserId`: `[apiUserId]`, + `ipAddress`: `192.0.2.0%2F24`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteServerlessPrivateEndpoint`: { + `deleteOrgInvite`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endpointId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.`, - }, `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.`, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, }, - `instanceName`: { - Usage: `Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.`, + `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{ @@ -3466,73 +3542,61 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `endpointId`: `[endpointId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `instanceName`: `[instanceName]`, + `invitationId`: `[invitationId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteServiceAccount`: { + `deleteOrgLiveMigrationLinkTokens`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `orgId`: `4888442a3354817a7320eb61`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteServiceAccountAccessListEntry`: { + `deleteOrgResourcePolicy`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, - `ipAddress`: { - Usage: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, - }, `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{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `ipAddress`: `192.0.2.0%2F24`, - `orgId`: `4888442a3354817a7320eb61`, + `orgId`: `4888442a3354817a7320eb61`, + `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteServiceAccountSecret`: { + `deleteOrgServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clientId`: { Usage: `The Client ID of the Service Account.`, @@ -3546,9 +3610,6 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `secretId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the secret.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2024-08-05`: {{ @@ -3557,108 +3618,101 @@ var metadata = metadatatypes.Metadata{ Flags: map[string]string{ `clientId`: `mdb_sa_id_1234567890abcdef12345678`, `orgId`: `4888442a3354817a7320eb61`, - `secretId`: `[secretId]`, }, }, }, }, }, - `deleteShardedClusterBackup`: { + `deleteOrgServiceAccountAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, + `ipAddress`: { + Usage: `One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, + }, + `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.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `ipAddress`: `192.0.2.0%2F24`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `deleteStreamConnection`: { + `deleteOrgServiceAccountSecret`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `connectionName`: { - Usage: `Human-readable label that identifies the stream connection.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, + `secretId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the secret.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `connectionName`: `[connectionName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `orgId`: `4888442a3354817a7320eb61`, + `secretId`: `[secretId]`, }, }, }, }, }, - `deleteStreamInstance`: { + `deleteOrgTeam`: { 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.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance to delete.`, + `teamId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the team that you want to delete.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `orgId`: `4888442a3354817a7320eb61`, + `teamId`: `[teamId]`, }, }, }, }, }, - `deleteStreamProcessor`: { + `disableGroupBackupCompliancePolicy`: { 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.`, @@ -3671,54 +3725,44 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processorName`: `[processorName]`, - `tenantName`: `[tenantName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteTeam`: { + `disableGroupManagedSlowMs`: { 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.`, + `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 that you want to delete.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `teamId`: `[teamId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `deleteThirdPartyIntegration`: { + `disableGroupPrivateIpModePeering`: { 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.`, @@ -3728,26 +3772,13 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `integrationType`: { - Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `integrationType`: `[integrationType]`, - }, - }, - }, - }, + Examples: nil, }, - `deleteVpcPeeringConnection`: { + `disableGroupUserSecurityCustomerX509`: { 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.`, @@ -3757,24 +3788,23 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `id`: { - Usage: `The VPC Peering Connection id.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, - `id`: `[id]`, }, }, }, }, }, - `disableCustomerManagedX509`: { + `downloadGroupClusterBackupTenant`: { 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.`, }, @@ -3783,20 +3813,17 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, + Examples: nil, }, - `disableDataProtectionSettings`: { + `downloadGroupClusterLog`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endDate`: { + Usage: `Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.`, + }, `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.`, }, @@ -3805,39 +3832,44 @@ var metadata = metadatatypes.Metadata{ **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.`, + `hostName`: { + Usage: `Human-readable label that identifies the host that stores the log files that you want to download.`, + }, + `logName`: { + Usage: `Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.`, + }, + `startDate`: { + Usage: `Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ - Source: `-`, + `2023-02-01`: {{ + Source: `get_host_logs`, + Name: `Download MongoDB logs for a specific cluster host`, + Description: `Returns a compressed (.gz) MongoDB log file containing log messages for the specified host`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `endDate`: `1609545600`, + `groupId`: `[your-project-id]`, + `hostName`: `[your-host-name]`, + `logName`: `mongodb`, + `startDate`: `1609459200`, }, }, }, }, }, - `disablePeering`: { + `downloadGroupClusterOnlineArchiveQueryLogs`: { 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.`, + `archiveOnly`: { + Usage: `Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.`, }, - `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.`, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `endDate`: { + Usage: `Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).`, }, - }, - Examples: nil, - }, - `disableSlowOperationThresholding`: { - 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.`, }, @@ -3846,8 +3878,8 @@ var metadata = metadatatypes.Metadata{ **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.`, + `startDate`: { + Usage: `Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -3855,13 +3887,16 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `endDate`: `1.636481348e+09`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `startDate`: `1.636481348e+09`, }, }, }, }, }, - `downloadFederatedDatabaseQueryLogs`: { + `downloadGroupDataFederationQueryLogs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `endDate`: { Usage: `Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, @@ -3892,7 +3927,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `downloadFlexBackup`: { + `downloadGroupFlexClusterBackup`: { 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.`, @@ -3911,44 +3946,42 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `downloadInvoiceCsv`: { + `downloadGroupStreamAuditLogs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endDate`: { + Usage: `Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, + }, `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.`, }, - `invoiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + `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.`, }, - `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.`, + `startDate`: { + Usage: `Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `invoiceId`: `[invoiceId]`, - `orgId`: `4888442a3354817a7320eb61`, + `endDate`: `1.636481348e+09`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `startDate`: `1.636466948e+09`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `downloadOnlineArchiveQueryLogs`: { + `enableGroupManagedSlowMs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `archiveOnly`: { - Usage: `Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.`, - }, - `endDate`: { - Usage: `Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).`, - }, `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.`, }, @@ -3957,8 +3990,8 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `startDate`: { - Usage: `Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -3966,19 +3999,16 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `endDate`: `1.636481348e+09`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `startDate`: `1.636481348e+09`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `downloadSharedClusterBackup`: { + `endGroupClusterOutageSimulation`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + Usage: `Human-readable label that identifies the cluster that is undergoing outage simulation.`, }, `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.`, @@ -3992,54 +4022,101 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, }, - `downloadStreamTenantAuditLogs`: { + `getFederationSettingConnectedOrgConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endDate`: { - Usage: `Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, - }, `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. + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, -**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.`, + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + `orgId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `startDate`: { - Usage: `Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, + }, + }, + `getFederationSettingConnectedOrgConfigRoleMapping`: { + 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `id`: { + Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.`, + }, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `endDate`: `1.636481348e+09`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `startDate`: `1.636466948e+09`, - `tenantName`: `[tenantName]`, + `federationSettingsId`: `55fa922fb343282757d9554e`, + `id`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `enableSlowOperationThresholding`: { + `getFederationSettingIdentityProvider`: { 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. + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `identityProviderId`: { + Usage: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-11-15`: {{ + Source: `-`, -**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.`, + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + }, + `getFederationSettingIdentityProviderMetadata`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `identityProviderId`: { + Usage: `Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -4047,17 +4124,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `federationSettingsId`: `55fa922fb343282757d9554e`, + `identityProviderId`: `c2777a9eca931f29fc2f`, }, }, }, }, }, - `endOutageSimulation`: { + `getGroup`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that is undergoing outage simulation.`, - }, `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.`, }, @@ -4072,20 +4147,21 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `-`, + Source: `get_project`, + Name: `Get a project`, + Description: `Get a project using a project id`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getAccountDetails`: { + `getGroupAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `One of "aws", "azure" or "gcp".`, + `entryValue`: { + Usage: `Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (` + "`" + `/` + "`" + `) with its URL-encoded value (` + "`" + `%2F` + "`" + `).`, }, `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.`, @@ -4095,25 +4171,29 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `regionName`: { - Usage: `The cloud provider specific region name, i.e. "US_EAST_1" for cloud provider "aws".`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ - Source: `-`, + `2023-01-01`: {{ + Source: `project_ip_access_list_get`, + Name: `Return One Project IP Access List Entry`, + Description: `Returns one access list entry from the specified project's IP access list: 10.0.0.0/16`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `regionName`: `[regionName]`, + `entryValue`: `10.0.0.0/16`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `getActiveVpcPeeringConnections`: { + `getGroupAccessListStatus`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `entryValue`: { + Usage: `Network address or cloud provider security construct that identifies which project access list entry to be verified.`, + }, `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.`, }, @@ -4122,28 +4202,25 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ - Source: `-`, + `2023-01-01`: {{ + Source: `project_ip_access_list_get_status`, + Name: `Return Status of One Project IP Access List Entry`, + Description: `Returns the status of 10.0.0.0/16`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `entryValue`: `10.0.0.0/16`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `getAlert`: { + `getGroupAlert`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `alertId`: { Usage: `Unique 24-hexadecimal digit string that identifies the alert.`, @@ -4172,10 +4249,10 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getAlertConfiguration`: { + `getGroupAlertAlertConfigs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `alertConfigId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + `alertId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the alert.`, }, `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.`, @@ -4185,6 +4262,15 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -4194,23 +4280,25 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `alertConfigId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `alertId`: `[alertId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getApiKey`: { + `getGroupAlertConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.`, + `alertConfigId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, }, `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.`, + `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.`, @@ -4221,26 +4309,34 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `orgId`: `4888442a3354817a7320eb61`, + `alertConfigId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getApiKeyAccessList`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, + `getGroupAlertConfigAlerts`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `alertConfigId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, }, `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.`, }, - `ipAddress`: { - Usage: `One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, + `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.`, }, - `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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -4251,15 +4347,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `ipAddress`: `192.0.2.0%2F24`, - `orgId`: `4888442a3354817a7320eb61`, + `alertConfigId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getAtlasProcess`: { + `getGroupAuditLog`: { 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.`, @@ -4272,27 +4367,20 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `mongodb.example.com:27017`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getAtlasSearchDeployment`: { + `getGroupAwsCustomDns`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Label that identifies the cluster to return the Search Nodes for.`, - }, `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.`, }, @@ -4306,22 +4394,18 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2025-03-12`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getAtlasSearchIndex`: { + `getGroupBackupCompliancePolicy`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, - }, `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.`, }, @@ -4330,72 +4414,63 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `indexId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-10-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `indexId`: `[indexId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getAtlasSearchIndexByName`: { + `getGroupBackupExportBucket`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, - }, - `collectionName`: { - Usage: `Name of the collection that contains one or more Atlas Search indexes.`, - }, - `databaseName`: { - Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, - }, `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.`, }, + `exportBucketId`: { + Usage: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, + }, `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.`, }, - `indexName`: { - Usage: `Name of the Atlas Search index to return.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `collectionName`: `[collectionName]`, - `databaseName`: `[databaseName]`, + `exportBucketId`: `32b6e34b3d91647abb20e7b8`, `groupId`: `32b6e34b3d91647abb20e7b8`, - `indexName`: `[indexName]`, }, }, }, }, }, - `getAtlasSearchIndexDeprecated`: { + `getGroupByName`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + `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.`, + }, + `groupName`: { + Usage: `Human-readable label that identifies this project.`, }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + Examples: nil, + }, + `getGroupCloudProviderAccess`: { + 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.`, }, @@ -4404,28 +4479,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `indexId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `roleId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the role.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `indexId`: `[indexId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `roleId`: `[roleId]`, }, }, }, }, }, - `getAuditingConfiguration`: { + `getGroupCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, }, @@ -4439,18 +4516,27 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, + `2024-08-05`: {{ + Source: `get_cluster`, + Name: `Get details of a specific cluster`, + Description: `Returns the details for the specified cluster in the project`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[your-cluster-name]`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `getAwsCustomDns`: { + `getGroupClusterBackupCheckpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `checkpointId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the checkpoint.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the checkpoints that you want to return.`, + }, `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.`, }, @@ -4468,13 +4554,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `checkpointId`: `[checkpointId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getBackupExportJob`: { + `getGroupClusterBackupExport`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -4504,7 +4592,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getBackupRestoreJob`: { + `getGroupClusterBackupRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster with the restore jobs you want to return.`, @@ -4537,7 +4625,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getBackupSchedule`: { + `getGroupClusterBackupSchedule`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -4566,8 +4654,11 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getCloudProviderAccessRole`: { + `getGroupClusterBackupSnapshot`: { 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.`, }, @@ -4579,8 +4670,8 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `roleId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the role.`, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -4588,17 +4679,18 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `roleId`: `[roleId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `getCluster`: { + `getGroupClusterBackupSnapshotShardedCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies this cluster.`, + 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.`, @@ -4611,22 +4703,24 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `get_cluster`, - Name: `Get details of a specific cluster`, - Description: `Returns the details for the specified cluster in the project`, + `2023-01-01`: {{ + Source: `-`, Flags: map[string]string{ - `clusterName`: `[your-cluster-name]`, - `groupId`: `[your-project-id]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `getClusterAdvancedConfiguration`: { + `getGroupClusterBackupTenantRestore`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -4642,20 +4736,24 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `restoreId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ `clusterName`: `[clusterName]`, `groupId`: `32b6e34b3d91647abb20e7b8`, + `restoreId`: `[restoreId]`, }, }, }, }, }, - `getClusterStatus`: { + `getGroupClusterBackupTenantSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -4671,6 +4769,9 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ @@ -4679,70 +4780,20 @@ var metadata = metadatatypes.Metadata{ Flags: map[string]string{ `clusterName`: `[clusterName]`, `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `getCollStatsLatencyNamespaceClusterMeasurements`: { + `getGroupClusterCollStatNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster to retrieve metrics for.`, + Usage: `Human-readable label that identifies the cluster to pin namespaces to.`, }, `clusterView`: { Usage: `Human-readable label that identifies the cluster topology to retrieve metrics for.`, }, - `collectionName`: { - Usage: `Human-readable label that identifies the collection.`, - }, - `databaseName`: { - Usage: `Human-readable label that identifies the database.`, - }, - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, - `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.`, - }, - `metrics`: { - Usage: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, - }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, - }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ - Source: `-`, - - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `clusterView`: `[clusterView]`, - `collectionName`: `mycoll`, - `databaseName`: `mydb`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, - }, - }, - }, - }, - }, - `getCollStatsLatencyNamespaceHostMeasurements`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `collectionName`: { - Usage: `Human-readable label that identifies the collection.`, - }, - `databaseName`: { - Usage: `Human-readable label that identifies the database.`, - }, `end`: { Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, @@ -4754,15 +4805,9 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `metrics`: { - Usage: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, - }, `period`: { Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, }, - `processId`: { - Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, `start`: { Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, @@ -4772,48 +4817,19 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `collectionName`: `mycoll`, - `databaseName`: `mydb`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, - `processId`: `my.host.name.com:27017`, - }, - }, - }, - }, - }, - `getCollStatsLatencyNamespaceMetrics`: { - 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.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `clusterView`: `[clusterView]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, }, }, }, }, }, - `getCollStatsLatencyNamespacesForCluster`: { + `getGroupClusterFtsIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster to pin namespaces to.`, - }, - `clusterView`: { - Usage: `Human-readable label that identifies the cluster topology to retrieve metrics for.`, - }, - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, }, `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.`, @@ -4823,31 +4839,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + `indexId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.`, }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ `clusterName`: `[clusterName]`, - `clusterView`: `[clusterView]`, `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, + `indexId`: `[indexId]`, }, }, }, }, }, - `getCollStatsLatencyNamespacesForHost`: { + `getGroupClusterGlobalWrites`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, @@ -4857,39 +4872,40 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, - }, - `processId`: { - Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, - `processId`: `my.host.name.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getConnectedOrgConfig`: { + `getGroupClusterOnlineArchive`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `archiveId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the online archive to return.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.`, + }, `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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -4897,23 +4913,29 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `orgId`: `32b6e34b3d91647abb20e7b8`, + `archiveId`: `[archiveId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getCostExplorerQueryProcess`: { + `getGroupClusterOutageSimulation`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that is undergoing outage simulation.`, + }, `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.`, + `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.`, }, - `token`: { - Usage: `Unique 64 digit string that identifies the Cost Explorer query.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -4921,15 +4943,18 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `token`: `4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getCustomDatabaseRole`: { + `getGroupClusterProcessArgs`: { 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.`, }, @@ -4941,26 +4966,23 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `roleName`: { - Usage: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `roleName`: `[roleName]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getDataFederationPrivateEndpoint`: { + `getGroupClusterQueryShapeInsightDetails`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endpointId`: { - Usage: `Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, + `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.`, @@ -4973,21 +4995,43 @@ var metadata = metadatatypes.Metadata{ `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{ - `2023-01-01`: {{ + `2025-03-12`: {{ Source: `-`, Flags: map[string]string{ - `endpointId`: `[endpointId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `queryShapeHash`: `[queryShapeHash]`, }, }, }, }, }, - `getDataProtectionSettings`: { + `getGroupClusterRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + }, `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.`, }, @@ -4996,25 +5040,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `jobId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the restore job.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-10-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `jobId`: `[jobId]`, }, }, }, }, }, - `getDatabase`: { + `getGroupClusterSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `databaseName`: { - Usage: `Human-readable label that identifies the database that the specified MongoDB process serves.`, + `clusterName`: { + Usage: `Label that identifies the cluster to return the Search Nodes for.`, }, `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.`, @@ -5027,77 +5076,62 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-03-12`: {{ Source: `-`, Flags: map[string]string{ - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getDatabaseMeasurements`: { + `getGroupClusterSearchIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `databaseName`: { - Usage: `Human-readable label that identifies the database that the specified MongoDB process serves.`, - }, - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `clusterName`: { + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, }, `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.`, }, - `granularity`: { - Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - }, `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.`, }, - `m`: { - Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, - }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + `indexId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `databaseName`: `[databaseName]`, - `granularity`: `PT1M`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `indexId`: `[indexId]`, }, }, }, }, }, - `getDatabaseUser`: { + `getGroupClusterSearchIndexByName`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + }, + `collectionName`: { + Usage: `Name of the collection that contains one or more Atlas Search indexes.`, + }, `databaseName`: { - Usage: `The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be ` + "`" + `$external` + "`" + `. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be ` + "`" + `admin` + "`" + `.`, + Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, }, `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.`, @@ -5107,72 +5141,46 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `indexName`: { + Usage: `Name of the Atlas Search index to return.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `username`: { - Usage: `Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: - -| Authentication Method | Parameter Needed | Parameter Value | username Format | -|---|---|---|---| -| AWS IAM | awsIAMType | ROLE | ARN | -| AWS IAM | awsIAMType | USER | ARN | -| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | -| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | -| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | -| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | -`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `username`: `SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName`, + `clusterName`: `[clusterName]`, + `collectionName`: `[collectionName]`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `indexName`: `[indexName]`, }, }, }, }, }, - `getDiskMeasurements`: { + `getGroupClusterSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `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.`, }, - `granularity`: { - Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - }, `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.`, }, - `m`: { - Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, - }, - `partitionName`: { - Usage: `Human-readable label of the disk or partition to which the measurements apply.`, - }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -5180,18 +5188,19 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `granularity`: `PT1M`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `partitionName`: `[partitionName]`, - `period`: `PT10H`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `[snapshotId]`, }, }, }, }, }, - `getEncryptionAtRest`: { + `getGroupClusterSnapshotSchedule`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + }, `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.`, }, @@ -5209,19 +5218,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getEncryptionAtRestPrivateEndpoint`: { + `getGroupClusterStatus`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Human-readable label that identifies the cloud provider of the private endpoint.`, - }, - `endpointId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint.`, + `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.`, @@ -5239,19 +5246,18 @@ var metadata = metadatatypes.Metadata{ `2023-01-01`: {{ Source: `-`, - Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `endpointId`: `[endpointId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getEncryptionAtRestPrivateEndpointsForCloudProvider`: { + `getGroupContainer`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Human-readable label that identifies the cloud provider for the private endpoints to return.`, + `containerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.`, }, `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.`, @@ -5261,15 +5267,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -5279,40 +5276,43 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `containerId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getExportBucket`: { + `getGroupCustomDbRoleRole`: { 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.`, }, - `exportBucketId`: { - Usage: `Unique 24-hexadecimal character string that identifies the Export Bucket.`, - }, `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.`, + }, + `roleName`: { + Usage: `Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `exportBucketId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `roleName`: `[roleName]`, }, }, }, }, }, - `getFederatedDatabase`: { + `getGroupDataFederation`: { 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.`, @@ -5338,31 +5338,52 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getFederationSettings`: { + `getGroupDataFederationLimit`: { 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.`, + `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.`, + }, + `limitName`: { + Usage: `Human-readable label that identifies this data federation instance limit. + +| Limit Name | Description | Default | +| --- | --- | --- | +| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | +| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | +| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | +| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | +`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `limitName`: `[limitName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `getFlexBackup`: { + `getGroupDatabaseUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `databaseName`: { + Usage: `The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be ` + "`" + `$external` + "`" + `. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be ` + "`" + `admin` + "`" + `.`, + }, `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.`, }, @@ -5371,28 +5392,50 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `username`: { + Usage: `Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: + +| Authentication Method | Parameter Needed | Parameter Value | username Format | +|---|---|---|---| +| AWS IAM | awsIAMType | ROLE | ARN | +| AWS IAM | awsIAMType | USER | ARN | +| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | +| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name | +| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name | +| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | +`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, - `snapshotId`: `32b6e34b3d91647abb20e7b8`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `username`: `SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName`, }, }, }, }, }, - `getFlexBackupRestoreJob`: { + `getGroupDbAccessHistoryCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `authResult`: { + Usage: `Flag that indicates whether the response returns the successful authentication attempts only.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, + }, + `end`: { + Usage: `Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.`, + }, `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.`, }, @@ -5401,31 +5444,39 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, + `ipAddress`: { + Usage: `One Internet Protocol address that attempted to authenticate with the database.`, + }, + `nLogs`: { + Usage: `Maximum number of lines from the log to return.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `restoreJobId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + `start`: { + Usage: `Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, - `restoreJobId`: `[restoreJobId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getFlexCluster`: { + `getGroupDbAccessHistoryProcess`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `authResult`: { + Usage: `Flag that indicates whether the response returns the successful authentication attempts only.`, + }, + `end`: { + Usage: `Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.`, + }, `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.`, }, @@ -5434,30 +5485,36 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, + `hostname`: { + Usage: `Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.`, + }, + `ipAddress`: { + Usage: `One Internet Protocol address that attempted to authenticate with the database.`, + }, + `nLogs`: { + Usage: `Maximum number of lines from the log to return.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `hostname`: `[hostname]`, }, }, }, }, }, - `getGroupClusterQueryShapeInsightDetails`: { + `getGroupEncryptionAtRest`: { 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.`, }, @@ -5469,45 +5526,25 @@ var metadata = metadatatypes.Metadata{ `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`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `queryShapeHash`: `[queryShapeHash]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getGroupClusterQueryShapeInsightSummaries`: { + `getGroupEncryptionAtRestPrivateEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `cloudProvider`: { + Usage: `Human-readable label that identifies the cloud provider of the private endpoint.`, }, - `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.`, + `endpointId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint.`, }, `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.`, @@ -5517,181 +5554,148 @@ var metadata = metadatatypes.Metadata{ **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`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `cloudProvider`: `[cloudProvider]`, + `endpointId`: `[endpointId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getHostLogs`: { + `getGroupEvent`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endDate`: { - Usage: `Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.`, - }, `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.`, }, + `eventId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the event that you want to return.`, + }, `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.`, }, - `hostName`: { - Usage: `Human-readable label that identifies the host that stores the log files that you want to download.`, - }, - `logName`: { - Usage: `Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.`, + `includeRaw`: { + Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, }, - `startDate`: { - Usage: `Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ - Source: `get_host_logs`, - Name: `Download MongoDB logs for a specific cluster host`, - Description: `Returns a compressed (.gz) MongoDB log file containing log messages for the specified host`, + `2023-01-01`: {{ + Source: `-`, Flags: map[string]string{ - `endDate`: `1609545600`, - `groupId`: `[your-project-id]`, - `hostName`: `[your-host-name]`, - `logName`: `mongodb`, - `startDate`: `1609459200`, + `eventId`: `[eventId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getHostMeasurements`: { + `getGroupFlexCluster`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, `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.`, }, - `granularity`: { - Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - }, `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.`, }, - `m`: { - Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, - }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `granularity`: `PT1M`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `period`: `PT10H`, - `processId`: `mongodb.example.com:27017`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `getIdentityProvider`: { + `getGroupFlexClusterBackupRestoreJob`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, }, - `identityProviderId`: { - Usage: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `restoreJobId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, + `restoreJobId`: `[restoreJobId]`, }, }, }, }, }, - `getIdentityProviderMetadata`: { + `getGroupFlexClusterBackupSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, }, - `identityProviderId`: { - Usage: `Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.`, + `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.`, + }, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, + }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `identityProviderId`: `c2777a9eca931f29fc2f`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, + `snapshotId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getIndexMetrics`: { + `getGroupHostFtsMetricIndexMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `collectionName`: { Usage: `Human-readable label that identifies the collection.`, @@ -5747,16 +5751,18 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getInvoice`: { + `getGroupIntegration`: { 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.`, }, - `invoiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + `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.`, }, - `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.`, + `integrationType`: { + Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -5767,14 +5773,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `invoiceId`: `[invoiceId]`, - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `integrationType`: `[integrationType]`, }, }, }, }, }, - `getLdapConfiguration`: { + `getGroupInvite`: { 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.`, @@ -5784,6 +5790,9 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -5793,13 +5802,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `invitationId`: `[invitationId]`, }, }, }, }, }, - `getLdapConfigurationStatus`: { + `getGroupIpAddresses`: { 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.`, @@ -5812,30 +5822,20 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `requestId`: { - Usage: `Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `requestId`: `[requestId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getLegacyBackupCheckpoint`: { + `getGroupLimit`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `checkpointId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the checkpoint.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the checkpoints that you want to return.`, - }, `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.`, }, @@ -5843,6 +5843,25 @@ var metadata = metadatatypes.Metadata{ 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.`, + }, + `limitName`: { + Usage: `Human-readable label that identifies this project limit. + +| Limit Name | Description | Default | API Override Limit | +| --- | --- | --- | --- | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | +| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | +| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | +| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | +| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | +| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | +| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | +| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | +| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | +| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| +`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -5853,19 +5872,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `checkpointId`: `[checkpointId]`, - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `limitName`: `[limitName]`, }, }, }, }, }, - `getLegacyBackupRestoreJob`: { + `getGroupLiveMigration`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, - }, `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.`, }, @@ -5874,8 +5889,8 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `jobId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the restore job.`, + `liveMigrationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the migration.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -5886,19 +5901,41 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `jobId`: `[jobId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `liveMigrationId`: `6296fb4c7c7aa997cf94e9a8`, }, }, }, }, }, - `getLegacySnapshot`: { + `getGroupLiveMigrationValidateStatus`: { 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.`, + }, + `validationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the validation job.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + `validationId`: `507f1f77bcf86cd799439011`, + }, }, + }, + }, + }, + `getGroupMaintenanceWindow`: { + 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.`, }, @@ -5910,8 +5947,30 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, + `getGroupManagedSlowMs`: { + 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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -5919,18 +5978,19 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getLegacySnapshotSchedule`: { + `getGroupMongoDbVersions`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + `cloudProvider`: { + Usage: `Filter results to only one cloud provider.`, + }, + `defaultStatus`: { + Usage: `Filter results to only the default values per tier. This value must be DEFAULT.`, }, `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.`, @@ -5940,6 +6000,15 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `instanceSize`: { + Usage: `Filter results to only one instance size.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -5949,14 +6018,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `instanceSize`: `M10`, + `itemsPerPage`: `100`, }, }, }, }, }, - `getMaintenanceWindow`: { + `getGroupPeer`: { 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.`, @@ -5966,6 +6036,9 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `peerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -5976,16 +6049,14 @@ var metadata = metadatatypes.Metadata{ Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, + `peerId`: `[peerId]`, }, }, }, }, }, - `getManagedNamespace`: { + `getGroupPipeline`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this 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.`, }, @@ -5994,23 +6065,26 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, }, }, }, }, }, - `getManagedSlowMs`: { + `getGroupPipelineAvailableSchedules`: { 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.`, @@ -6020,6 +6094,9 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -6029,39 +6106,40 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, }, }, }, }, }, - `getMeasurements`: { + `getGroupPipelineAvailableSnapshots`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `completedAfter`: { + Usage: `Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.`, }, `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.`, }, - `granularity`: { - Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - }, `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.`, }, - `metrics`: { - Usage: `List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `processId`: { - Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -6069,24 +6147,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `granularity`: `PT1M`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `metrics`: `[metrics]`, - `period`: `PT10H`, - `processId`: `my.host.name.com:27017`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, }, }, }, }, }, - `getOnlineArchive`: { + `getGroupPipelineRun`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `archiveId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the online archive to return.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.`, - }, `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.`, }, @@ -6095,6 +6164,12 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, + `pipelineRunId`: { + Usage: `Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -6104,48 +6179,65 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `archiveId`: `[archiveId]`, - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `pipelineName`: `[pipelineName]`, + `pipelineRunId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getOrgResourcePolicy`: { + `getGroupPrivateEndpointEndpointService`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint service.`, + }, + `endpointServiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.`, + }, `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.`, + `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.`, }, - `resourcePolicyId`: { - Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, + `cloudProvider`: `[cloudProvider]`, + `endpointServiceId`: `[endpointServiceId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getOrganization`: { + `getGroupPrivateEndpointEndpointServiceEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint.`, + }, + `endpointId`: { + Usage: `Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.`, + }, + `endpointServiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.`, + }, `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.`, + `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.`, @@ -6156,25 +6248,24 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `cloudProvider`: `[cloudProvider]`, + `endpointId`: `[endpointId]`, + `endpointServiceId`: `[endpointServiceId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getOrganizationEvent`: { + `getGroupPrivateEndpointRegionalMode`: { 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.`, }, - `eventId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the event that you want to return.`, - }, - `includeRaw`: { - Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, - }, - `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.`, + `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.`, @@ -6185,23 +6276,27 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `eventId`: `[eventId]`, - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getOrganizationInvitation`: { + `getGroupPrivateEndpointServerlessInstanceEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endpointId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint.`, + }, `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.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + `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.`, }, - `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.`, + `instanceName`: { + Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -6209,20 +6304,26 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `invitationId`: `[invitationId]`, - `orgId`: `4888442a3354817a7320eb61`, + `endpointId`: `[endpointId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `instanceName`: `[instanceName]`, }, }, }, }, }, - `getOrganizationSettings`: { + `getGroupPrivateNetworkSettingEndpointId`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endpointId`: { + Usage: `Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.`, + }, `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.`, + `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.`, @@ -6233,43 +6334,46 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `endpointId`: `[endpointId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getOrganizationUser`: { + `getGroupProcess`: { 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.`, + `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.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `userId`: `[userId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getOutageSimulation`: { + `getGroupProcessCollStatNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that is undergoing outage simulation.`, + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, `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.`, @@ -6279,24 +6383,34 @@ var metadata = metadatatypes.Metadata{ **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.`, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + }, + `processId`: { + Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-11-15`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, + `processId`: `my.host.name.com:27017`, }, }, }, }, }, - `getPeeringConnection`: { + `getGroupProcessDatabase`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `databaseName`: { + Usage: `Human-readable label that identifies the database that the specified MongoDB process serves.`, + }, `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.`, }, @@ -6305,59 +6419,78 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `peerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `peerId`: `[peerId]`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getPeeringContainer`: { + `getGroupProcessDatabaseMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `containerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.`, + `databaseName`: { + Usage: `Human-readable label that identifies the database that the specified MongoDB process serves.`, + }, + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, `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.`, }, + `granularity`: { + Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + }, `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.`, }, + `m`: { + Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, + }, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `containerId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `databaseName`: `[databaseName]`, + `granularity`: `PT1M`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getPinnedNamespaces`: { + `getGroupProcessDisk`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster to retrieve pinned namespaces for.`, - }, `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.`, }, @@ -6366,92 +6499,124 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `partitionName`: { + Usage: `Human-readable label of the disk or partition to which the measurements apply.`, + }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `partitionName`: `[partitionName]`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getPipeline`: { + `getGroupProcessDiskMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, }, + `granularity`: { + Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + }, `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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + `m`: { + Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, + }, + `partitionName`: { + Usage: `Human-readable label of the disk or partition to which the measurements apply.`, + }, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, + `granularity`: `PT1M`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `partitionName`: `[partitionName]`, + `period`: `PT10H`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getPipelineRun`: { + `getGroupProcessMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, }, + `granularity`: { + Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, + }, `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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + `m`: { + Usage: `One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for ` + "`" + `m` + "`" + `, repeat the ` + "`" + `m` + "`" + ` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.`, }, - `pipelineRunId`: { - Usage: `Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.`, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, - `pipelineRunId`: `32b6e34b3d91647abb20e7b8`, + `granularity`: `PT1M`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `getPrivateEndpoint`: { + `getGroupPushBasedLogExport`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint.`, - }, - `endpointId`: { - Usage: `Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.`, - }, - `endpointServiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.`, - }, `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.`, }, @@ -6469,23 +6634,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `endpointId`: `[endpointId]`, - `endpointServiceId`: `[endpointServiceId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getPrivateEndpointService`: { + `getGroupSampleDatasetLoad`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint service.`, - }, - `endpointServiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.`, - }, `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.`, }, @@ -6494,8 +6650,8 @@ var metadata = metadatatypes.Metadata{ **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.`, + `sampleDatasetId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the loaded sample dataset.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -6503,18 +6659,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `endpointServiceId`: `[endpointServiceId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `sampleDatasetId`: `[sampleDatasetId]`, }, }, }, }, }, - `getPrivateLinkConnection`: { + `getGroupServerlessBackupRestoreJob`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `connectionId`: { - Usage: `Unique ID that identifies the Private Link connection.`, + `clusterName`: { + Usage: `Human-readable label that identifies the serverless instance.`, }, `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.`, @@ -6524,21 +6679,31 @@ var metadata = metadatatypes.Metadata{ **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.`, + }, + `restoreJobId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `connectionId`: `[connectionId]`, + `clusterName`: `[clusterName]`, `groupId`: `32b6e34b3d91647abb20e7b8`, + `restoreJobId`: `[restoreJobId]`, }, }, }, }, }, - `getProject`: { + `getGroupServerlessBackupSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the serverless instance.`, + }, `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.`, }, @@ -6547,52 +6712,35 @@ var metadata = metadatatypes.Metadata{ **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.`, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `get_project`, - Name: `Get a project`, - Description: `Get a project using a project id`, + Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `snapshotId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getProjectByName`: { - 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.`, - }, - `groupName`: { - Usage: `Human-readable label that identifies this project.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: nil, - }, - `getProjectEvent`: { + `getGroupServerlessInstance`: { 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.`, }, - `eventId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the event that you want to return.`, - }, `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.`, }, - `includeRaw`: { - Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, + `name`: { + Usage: `Human-readable label that identifies the serverless instance.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -6603,15 +6751,18 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `eventId`: `[eventId]`, `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `getProjectInvitation`: { + `getGroupServerlessPerformanceAdvisorAutoIndexing`: { 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.`, }, @@ -6620,9 +6771,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -6632,17 +6780,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `invitationId`: `[invitationId]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getProjectIpAccessListStatus`: { + `getGroupServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `entryValue`: { - Usage: `Network address or cloud provider security construct that identifies which project access list entry to be verified.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, @@ -6657,24 +6805,19 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `project_ip_access_list_get_status`, - Name: `Return Status of One Project IP Access List Entry`, - Description: `Returns the status of 10.0.0.0/16`, + `2024-08-05`: {{ + Source: `-`, Flags: map[string]string{ - `entryValue`: `10.0.0.0/16`, - `groupId`: `[your-project-id]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getProjectIpList`: { + `getGroupSettings`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `entryValue`: { - Usage: `Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (` + "`" + `/` + "`" + `) with its URL-encoded value (` + "`" + `%2F` + "`" + `).`, - }, `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.`, }, @@ -6689,20 +6832,20 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `project_ip_access_list_get`, - Name: `Return One Project IP Access List Entry`, - Description: `Returns one access list entry from the specified project's IP access list: 10.0.0.0/16`, + Source: `-`, Flags: map[string]string{ - `entryValue`: `10.0.0.0/16`, - `groupId`: `[your-project-id]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getProjectLimit`: { + `getGroupStreamAccountDetails`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `One of "aws", "azure" or "gcp".`, + }, `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.`, }, @@ -6711,49 +6854,27 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `limitName`: { - Usage: `Human-readable label that identifies this project limit. - -| Limit Name | Description | Default | API Override Limit | -| --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | -| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | -| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | -| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | -| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | -| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | -| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | -| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | -| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | -| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | -`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `regionName`: { + Usage: `The cloud provider specific region name, i.e. "US_EAST_1" for cloud provider "aws".`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `limitName`: `[limitName]`, + `cloudProvider`: `[cloudProvider]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `regionName`: `[regionName]`, }, }, }, }, }, - `getProjectLtsVersions`: { + `getGroupStreamConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Filter results to only one cloud provider.`, - }, - `defaultStatus`: { - Usage: `Filter results to only the default values per tier. This value must be DEFAULT.`, + `connectionName`: { + Usage: `Human-readable label that identifies the stream connection to return.`, }, `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.`, @@ -6763,36 +6884,27 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `instanceSize`: { - Usage: `Filter results to only one instance size.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance to return.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `instanceSize`: `M10`, - `itemsPerPage`: `100`, + `connectionName`: `[connectionName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `getProjectServiceAccount`: { + `getGroupStreamPrivateLinkConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, + `connectionId`: { + Usage: `Unique ID that identifies the Private Link connection.`, }, `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.`, @@ -6802,23 +6914,20 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `connectionId`: `[connectionId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getProjectSettings`: { + `getGroupStreamProcessor`: { 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.`, @@ -6831,19 +6940,27 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processorName`: `[processorName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `getProjectTeam`: { + `getGroupStreamProcessors`: { 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.`, @@ -6853,26 +6970,35 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `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.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `teamId`: `[teamId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `getProjectUser`: { + `getGroupStreamWorkspace`: { 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.`, @@ -6882,26 +7008,26 @@ var metadata = metadatatypes.Metadata{ **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.`, + `includeConnections`: { + Usage: `Flag to indicate whether connections information should be included in the stream instance.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance to return.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `userId`: `[userId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `getPushBasedLogConfiguration`: { + `getGroupTeam`: { 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.`, @@ -6914,6 +7040,9 @@ var metadata = metadatatypes.Metadata{ `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`: {{ @@ -6921,12 +7050,13 @@ var metadata = metadatatypes.Metadata{ Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, + `teamId`: `[teamId]`, }, }, }, }, }, - `getPushMigration`: { + `getGroupUser`: { 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.`, @@ -6936,26 +7066,26 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `liveMigrationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the migration.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `liveMigrationId`: `6296fb4c7c7aa997cf94e9a8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `userId`: `[userId]`, }, }, }, }, }, - `getRegionalizedPrivateEndpointSetting`: { + `getGroupUserSecurity`: { 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.`, @@ -6980,11 +7110,8 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getReplicaSetBackup`: { + `getGroupUserSecurityLdapVerify`: { 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.`, }, @@ -6996,8 +7123,8 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `requestId`: { + Usage: `Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -7005,15 +7132,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `requestId`: `[requestId]`, }, }, }, }, }, - `getResourcesNonCompliant`: { + `getOrg`: { 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.`, @@ -7026,7 +7152,7 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ @@ -7036,46 +7162,49 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getRoleMapping`: { + `getOrgApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.`, + }, `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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `id`: { - Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.`, - }, `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{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `id`: `32b6e34b3d91647abb20e7b8`, - `orgId`: `4888442a3354817a7320eb61`, + `apiUserId`: `[apiUserId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getSampleDatasetLoadStatus`: { + `getOrgApiKeyAccessListEntry`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, + }, `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.`, + `ipAddress`: { + Usage: `One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.`, }, - `sampleDatasetId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the loaded sample dataset.`, + `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{ @@ -7083,28 +7212,24 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `sampleDatasetId`: `[sampleDatasetId]`, + `apiUserId`: `[apiUserId]`, + `ipAddress`: `192.0.2.0%2F24`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getServerlessAutoIndexing`: { + `getOrgBillingCostExplorerUsage`: { 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.`, + `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.`, + `token`: { + Usage: `Unique 64 digit string that identifies the Cost Explorer query.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -7112,28 +7237,29 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, + `token`: `4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C`, }, }, }, }, }, - `getServerlessBackup`: { + `getOrgEvent`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the serverless instance.`, - }, `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.`, + `eventId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the event that you want to return.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `includeRaw`: { + Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, + }, + `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{ @@ -7141,59 +7267,55 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `32b6e34b3d91647abb20e7b8`, + `eventId`: `[eventId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getServerlessBackupRestoreJob`: { + `getOrgFederationSettings`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the serverless instance.`, - }, `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.`, + `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.`, }, - `restoreJobId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `restoreJobId`: `[restoreJobId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getServerlessInstance`: { + `getOrgGroups`: { 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, `name`: { - Usage: `Human-readable label that identifies the serverless instance.`, + Usage: `Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.`, + }, + `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.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -7204,28 +7326,22 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getServerlessPrivateEndpoint`: { + `getOrgInvite`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endpointId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint.`, - }, `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.`, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, }, - `instanceName`: { - Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -7233,22 +7349,21 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `endpointId`: `[endpointId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `instanceName`: `[instanceName]`, + `invitationId`: `[invitationId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getServiceAccount`: { + `getOrgInvoice`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, + `invoiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + }, `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.`, }, @@ -7257,220 +7372,178 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `orgId`: `4888442a3354817a7320eb61`, + `invoiceId`: `[invoiceId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getShardedClusterBackup`: { + `getOrgInvoiceCsv`: { 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.`, + `invoiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + }, + `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.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `invoiceId`: `[invoiceId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getSharedClusterBackup`: { + `getOrgNonCompliantResources`: { 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.`, + `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.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `snapshotId`: `[snapshotId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getSharedClusterBackupRestoreJob`: { + `getOrgResourcePolicy`: { 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.`, + `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.`, }, - `restoreId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the restore job to return.`, + `resourcePolicyId`: { + Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `restoreId`: `[restoreId]`, + `orgId`: `4888442a3354817a7320eb61`, + `resourcePolicyId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `getStreamConnection`: { + `getOrgServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `connectionName`: { - Usage: `Human-readable label that identifies the stream connection to return.`, - }, - `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.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance to return.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `connectionName`: `[connectionName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, - }, - }, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, - }, - }, - `getStreamInstance`: { - 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.`, - }, - `includeConnections`: { - Usage: `Flag to indicate whether connections information should be included in the stream instance.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance to return.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getStreamProcessor`: { + `getOrgServiceAccountGroups`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `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.`, }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processorName`: `[processorName]`, - `tenantName`: `[tenantName]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `getSystemStatus`: { + `getOrgSettings`: { 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, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `orgId`: `4888442a3354817a7320eb61`, + }, + }, + }, + }, }, - `getTeamById`: { + `getOrgTeam`: { 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.`, @@ -7497,7 +7570,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getTeamByName`: { + `getOrgTeamByName`: { 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.`, @@ -7524,35 +7597,44 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getThirdPartyIntegration`: { + `getOrgUser`: { 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.`, - }, - `integrationType`: { - Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, + `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.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `integrationType`: `[integrationType]`, + `orgId`: `4888442a3354817a7320eb61`, + `userId`: `[userId]`, }, }, }, }, }, + `getSystemStatus`: { + 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.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + Examples: nil, + }, `getUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -7567,7 +7649,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `getUserByUsername`: { + `getUserByName`: { 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.`, @@ -7581,8 +7663,11 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `getValidationStatus`: { + `grantGroupClusterMongoDbEmployeeAccess`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, }, @@ -7591,24 +7676,17 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `validationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the validation job.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `validationId`: `507f1f77bcf86cd799439011`, - }, - }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, + Examples: nil, }, - `getVpcPeeringConnections`: { + `inviteGroupServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, }, @@ -7617,43 +7695,36 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `requesterAccountId`: { - Usage: `The Account ID of the VPC Peering connection/s.`, - }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `requesterAccountId`: `[requesterAccountId]`, - }, + Examples: nil, + }, + `listAlertConfigMatcherFieldNames`: { + 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.`, }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, + Examples: nil, }, - `grantMongoDbEmployeeAccess`: { + `listClusterDetails`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -7661,36 +7732,44 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `listAccessLogsByClusterName`: { + `listControlPlaneIpAddresses`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `authResult`: { - Usage: `Flag that indicates whether the response returns the successful authentication attempts only.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, - }, - `end`: { - Usage: `Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.`, + `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.`, }, + }, + Examples: nil, + }, + `listEventTypes`: { + 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - `ipAddress`: { - Usage: `One Internet Protocol address that attempted to authenticate with the database.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `nLogs`: { - Usage: `Maximum number of lines from the log to return.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.`, + }, + Examples: nil, + }, + `listFederationSettingConnectedOrgConfigRoleMappings`: { + 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -7698,43 +7777,26 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `federationSettingsId`: `55fa922fb343282757d9554e`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listAccessLogsByHostname`: { + `listFederationSettingConnectedOrgConfigs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `authResult`: { - Usage: `Flag that indicates whether the response returns the successful authentication attempts only.`, - }, - `end`: { - Usage: `Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.`, - }, `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.`, - }, - `hostname`: { - Usage: `Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.`, - }, - `ipAddress`: { - Usage: `One Internet Protocol address that attempted to authenticate with the database.`, - }, - `nLogs`: { - Usage: `Maximum number of lines from the log to return.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -7742,25 +7804,45 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `hostname`: `[hostname]`, + `federationSettingsId`: `55fa922fb343282757d9554e`, }, }, }, }, }, - `listAlertConfigurationMatchersFieldNames`: { + `listFederationSettingIdentityProviders`: { 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.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `idpType`: { + Usage: `The types of the target identity providers.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `protocol`: { + Usage: `The protocols of the target identity providers.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + }, + }, }, }, - Examples: nil, }, - `listAlertConfigurations`: { + `listGroupAccessListEntries`: { 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.`, @@ -7785,20 +7867,19 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `-`, + Source: `project_ip_access_list_list`, + Name: `Return project IP access list`, + Description: `Returns all access list entries from the specified project's IP access list.`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `listAlertConfigurationsByAlertId`: { + `listGroupAlertConfigs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `alertId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert.`, - }, `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.`, }, @@ -7825,14 +7906,13 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `alertId`: `[alertId]`, `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listAlerts`: { + `listGroupAlerts`: { 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.`, @@ -7869,11 +7949,8 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listAlertsByAlertConfigurationId`: { + `listGroupApiKeys`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `alertConfigId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, - }, `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.`, }, @@ -7900,30 +7977,28 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `alertConfigId`: `32b6e34b3d91647abb20e7b8`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listApiKeyAccessListsEntries`: { + `listGroupBackupExportBuckets`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, - }, `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.`, + }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `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.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -7932,33 +8007,25 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listApiKeys`: { + `listGroupCloudProviderAccess`: { 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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `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.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, @@ -7969,14 +8036,17 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listAtlasProcesses`: { + `listGroupClusterBackupCheckpoints`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the checkpoints that you want to return.`, + }, `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.`, }, @@ -8000,27 +8070,20 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `list_atlas_processes`, - Name: `List all processes for a project`, - Description: `Returns details of all processes for the specified project`, + Source: `-`, Flags: map[string]string{ - `groupId`: `[your-project-id]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listAtlasSearchIndexes`: { + `listGroupClusterBackupExports`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, - }, - `collectionName`: { - Usage: `Name of the collection that contains one or more Atlas Search indexes.`, - }, - `databaseName`: { - Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + 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.`, @@ -8030,28 +8093,35 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `collectionName`: `[collectionName]`, - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listAtlasSearchIndexesCluster`: { + `listGroupClusterBackupRestoreJobs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + Usage: `Human-readable label that identifies the cluster with the restore jobs you want to return.`, }, `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.`, @@ -8061,12 +8131,21 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ @@ -8077,16 +8156,10 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listAtlasSearchIndexesDeprecated`: { + `listGroupClusterBackupSnapshotShardedClusters`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, - }, - `collectionName`: { - Usage: `Name of the collection that contains one or more Atlas Search indexes.`, - }, - `databaseName`: { - Usage: `Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + 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.`, @@ -8105,16 +8178,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `collectionName`: `[collectionName]`, - `databaseName`: `[databaseName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listBackupExportJobs`: { + `listGroupClusterBackupSnapshots`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, @@ -8152,10 +8223,10 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listBackupRestoreJobs`: { + `listGroupClusterBackupTenantRestores`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the restore jobs you want to return.`, + 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.`, @@ -8165,15 +8236,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -8190,8 +8252,11 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listCloudProviderAccessRoles`: { + `listGroupClusterBackupTenantSnapshots`: { 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.`, }, @@ -8209,14 +8274,30 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listCloudProviderRegions`: { + `listGroupClusterCollStatMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster to retrieve metrics for.`, + }, + `clusterView`: { + Usage: `Human-readable label that identifies the cluster topology to retrieve metrics for.`, + }, + `collectionName`: { + Usage: `Human-readable label that identifies the collection.`, + }, + `databaseName`: { + Usage: `Human-readable label that identifies the database.`, + }, + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, }, @@ -8225,67 +8306,48 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `metrics`: { + Usage: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, }, - `providers`: { - Usage: `Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.`, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, }, - `tier`: { - Usage: `Cluster tier for which to retrieve the regions.`, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-11-15`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `clusterView`: `[clusterView]`, + `collectionName`: `mycoll`, + `databaseName`: `mydb`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, }, }, }, }, }, - `listClusterSuggestedIndexes`: { + `listGroupClusterCollStatPinnedNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + Usage: `Human-readable label that identifies the cluster to retrieve pinned namespaces for.`, + }, + `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.`, }, - `namespaces`: { - Usage: `Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, - }, - `processIds`: { - Usage: `ProcessIds from which to retrieve suggested indexes. 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.`, - }, - `since`: { - Usage: `Date and time from which the query retrieves the suggested indexes. 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 the query retrieves the suggested indexes. 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{ - `2024-08-05`: {{ + `2023-11-15`: {{ Source: `-`, Flags: map[string]string{ @@ -8296,8 +8358,17 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listClusters`: { + `listGroupClusterFtsIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + }, + `collectionName`: { + Usage: `Name of the collection that contains one or more Atlas Search indexes.`, + }, + `databaseName`: { + Usage: `Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + }, `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.`, }, @@ -8306,40 +8377,37 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `includeDeletedWithRetainedBackups`: { - Usage: `Flag that indicates whether to return Clusters with retain backups.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `list_clusters`, - Name: `List all clusters in a project`, - Description: `Returns all clusters in the specified project`, + `2023-01-01`: {{ + Source: `-`, Flags: map[string]string{ - `groupId`: `[your-project-id]`, + `clusterName`: `[clusterName]`, + `collectionName`: `[collectionName]`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listClustersForAllProjects`: { + `listGroupClusterOnlineArchives`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.`, + }, `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.`, + }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, @@ -8353,94 +8421,106 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, - }, - `listConnectedOrgConfigs`: { - 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.`, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + }, + }, + `listGroupClusterPerformanceAdvisorDropIndexSuggestions`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listCustomDatabaseRoles`: { + `listGroupClusterPerformanceAdvisorSchemaAdvice`: { 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.`, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, }, `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.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDataFederationPrivateEndpoints`: { + `listGroupClusterPerformanceAdvisorSuggestedIndexes`: { 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.`, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, }, `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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + `namespaces`: { + Usage: `Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + `processIds`: { + Usage: `ProcessIds from which to retrieve suggested indexes. 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.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `since`: { + Usage: `Date and time from which the query retrieves the suggested indexes. 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.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `until`: { + Usage: `Date and time up until which the query retrieves the suggested indexes. 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{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDatabaseUserCertificates`: { + `listGroupClusterProviderRegions`: { 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.`, @@ -8462,8 +8542,11 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `username`: { - Usage: `Human-readable label that represents the MongoDB database user account whose certificates you want to return.`, + `providers`: { + Usage: `Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.`, + }, + `tier`: { + Usage: `Cluster tier for which to retrieve the regions.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -8471,15 +8554,20 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `username`: `[username]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDatabaseUsers`: { + `listGroupClusterQueryShapeInsightSummaries`: { 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.`, }, @@ -8488,32 +8576,57 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + `nSummaries`: { + Usage: `Maximum number of query statistic summaries to return.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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{ - `2023-01-01`: {{ + `2025-03-12`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDatabases`: { + `listGroupClusterRestoreJobs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `batchId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + }, `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.`, }, @@ -8534,24 +8647,30 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (` + "`" + `mongod` + "`" + `). The port must be the IANA port on which the MongoDB process listens for requests.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDiskMeasurements`: { + `listGroupClusterSearchIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + }, + `collectionName`: { + Usage: `Name of the collection that contains one or more Atlas Search indexes.`, + }, + `databaseName`: { + Usage: `Label that identifies the database that contains the collection with one or more Atlas Search indexes.`, + }, `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.`, }, @@ -8560,28 +8679,29 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `partitionName`: { - Usage: `Human-readable label of the disk or partition to which the measurements apply.`, - }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `partitionName`: `[partitionName]`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `collectionName`: `[collectionName]`, + `databaseName`: `[databaseName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDiskPartitions`: { + `listGroupClusterSearchIndexes`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Name of the cluster that contains the collection with one or more Atlas Search indexes.`, + }, `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.`, }, @@ -8590,62 +8710,38 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `mongodb.example.com:27017`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listDropIndexes`: { + `listGroupClusterSnapshots`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster.`, }, + `completed`: { + Usage: `Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.`, + }, + `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.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, - - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, - `listEventTypes`: { - 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.`, - }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, @@ -8659,9 +8755,19 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, }, - `listExportBuckets`: { + `listGroupClusters`: { 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.`, @@ -8674,6 +8780,9 @@ var metadata = metadatatypes.Metadata{ `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, + `includeDeletedWithRetainedBackups`: { + Usage: `Flag that indicates whether to return Clusters with retain backups.`, + }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -8685,17 +8794,19 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ - Source: `-`, + `2024-08-05`: {{ + Source: `list_clusters`, + Name: `List all clusters in a project`, + Description: `Returns all clusters in the specified project`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `listFederatedDatabases`: { + `listGroupCollStatMetrics`: { 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.`, @@ -8705,15 +8816,9 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - `type`: { - Usage: `Type of Federated Database Instances to return.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-11-15`: {{ Source: `-`, Flags: map[string]string{ @@ -8723,7 +8828,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listFlexBackupRestoreJobs`: { + `listGroupContainerAll`: { 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.`, @@ -8739,9 +8844,6 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -8750,18 +8852,17 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, }, }, }, }, }, - `listFlexBackups`: { + `listGroupContainers`: { 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.`, @@ -8777,29 +8878,29 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `name`: { - Usage: `Human-readable label that identifies the flex cluster.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `providerName`: { + Usage: `Cloud service provider that serves the desired network peering containers.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `providerName`: `[providerName]`, }, }, }, }, }, - `listFlexClusters`: { + `listGroupCustomDbRoleRoles`: { 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.`, @@ -8809,21 +8910,40 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + }, + }, + `listGroupDataFederation`: { + 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.`, }, + `type`: { + Usage: `Type of Federated Database Instances to return.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2024-11-13`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ @@ -8833,25 +8953,21 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listIdentityProviders`: { + `listGroupDataFederationLimits`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `idpType`: { - Usage: `The types of the target identity providers.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + `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.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `protocol`: { - Usage: `The protocols of the target identity providers.`, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance for which you want to retrieve query limits.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -8859,45 +8975,37 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `listIndexMetrics`: { + `listGroupDatabaseUserCerts`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `collectionName`: { - Usage: `Human-readable label that identifies the collection.`, - }, - `databaseName`: { - Usage: `Human-readable label that identifies the database.`, - }, - `end`: { - Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, - }, `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.`, }, - `granularity`: { - Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, - }, `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.`, }, - `metrics`: { - Usage: `List that contains the measurements that MongoDB Atlas reports for the associated data series.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - `period`: { - Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `processId`: { - Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `start`: { - Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `username`: { + Usage: `Human-readable label that represents the MongoDB database user account whose certificates you want to return.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -8905,25 +9013,22 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `collectionName`: `mycoll`, - `databaseName`: `mydb`, - `granularity`: `PT1M`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - `metrics`: `[metrics]`, - `period`: `PT10H`, - `processId`: `my.host.name.com:27017`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `username`: `[username]`, }, }, }, }, }, - `listInvoices`: { + `listGroupDatabaseUsers`: { 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.`, }, - `fromDate`: { - Usage: `Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.`, + `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.`, }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, @@ -8931,49 +9036,28 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `orderBy`: { - Usage: `Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.`, - }, - `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.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `sortBy`: { - Usage: `Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.`, - }, - `statusNames`: { - Usage: `Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.`, - }, - `toDate`: { - Usage: `Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.`, - }, - `viewLinkedInvoices`: { - Usage: `Flag that indicates whether to return linked invoices in the linkedInvoices field.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `fromDate`: `2023-01-01`, - `orderBy`: `desc`, - `orgId`: `4888442a3354817a7320eb61`, - `toDate`: `2023-01-01`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listLegacyBackupCheckpoints`: { + `listGroupEncryptionAtRestPrivateEndpoints`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the checkpoints that you want to return.`, + `cloudProvider`: { + Usage: `Human-readable label that identifies the cloud provider for the private endpoints to return.`, }, `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.`, @@ -9001,24 +9085,31 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `cloudProvider`: `[cloudProvider]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listLegacyBackupRestoreJobs`: { + `listGroupEvents`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `batchId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + `clusterNames`: { + 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.`, }, + `eventType`: { + Usage: `Category of incident recorded at this moment in time. + +**IMPORTANT**: The complete list of event type values changes frequently.`, + }, + `excludedEventType`: { + Usage: `Category of event that you would like to exclude from query results, such as CLUSTER_CREATED + +**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.`, + }, `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. @@ -9027,9 +9118,18 @@ var metadata = metadatatypes.Metadata{ `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, + `includeRaw`: { + Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, + }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, + `maxDate`: { + Usage: `Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, + }, + `minDate`: { + Usage: `Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, + }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -9042,21 +9142,14 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listLegacySnapshots`: { + `listGroupFlexClusterBackupRestoreJobs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, - }, - `completed`: { - Usage: `Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.`, - }, `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.`, }, @@ -9071,6 +9164,9 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, + }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -9079,18 +9175,18 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `listMetricTypes`: { + `listGroupFlexClusterBackupSnapshots`: { 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.`, @@ -9100,27 +9196,36 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `processId`: { - Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `name`: { + Usage: `Human-readable label that identifies the flex cluster.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `my.host.name.com:27017`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, }, }, }, }, }, - `listOnlineArchives`: { + `listGroupFlexClusters`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.`, - }, `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.`, }, @@ -9143,73 +9248,95 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listOrgResourcePolicies`: { + `listGroupHostFtsMetricIndexMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `collectionName`: { + Usage: `Human-readable label that identifies the collection.`, + }, + `databaseName`: { + Usage: `Human-readable label that identifies the database.`, + }, + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, + `granularity`: { + Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `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.`, + }, + `metrics`: { + Usage: `List that contains the measurements that MongoDB Atlas reports for the associated data series.`, + }, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + }, + `processId`: { + Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `collectionName`: `mycoll`, + `databaseName`: `mydb`, + `granularity`: `PT1M`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `metrics`: `[metrics]`, + `period`: `PT10H`, + `processId`: `my.host.name.com:27017`, }, }, }, }, }, - `listOrganizationEvents`: { + `listGroupHostFtsMetricMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, }, - `eventType`: { - Usage: `Category of incident recorded at this moment in time. - -**IMPORTANT**: The complete list of event type values changes frequently.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `includeRaw`: { - Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `maxDate`: { - Usage: `Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, + `granularity`: { + Usage: `Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.`, }, - `minDate`: { - Usage: `Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, + `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.`, }, - `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.`, + `metrics`: { + Usage: `List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `processId`: { + Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -9217,25 +9344,28 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `granularity`: `PT1M`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `metrics`: `[metrics]`, + `period`: `PT10H`, + `processId`: `my.host.name.com:27017`, }, }, }, }, }, - `listOrganizationInvitations`: { + `listGroupHostFtsMetrics`: { 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.`, + `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.`, }, - `username`: { - Usage: `Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.`, + `processId`: { + Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -9243,29 +9373,29 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `my.host.name.com:27017`, }, }, }, }, }, - `listOrganizationProjects`: { + `listGroupIntegrations`: { 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.`, + }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `name`: { - Usage: `Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.`, - }, - `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.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -9278,107 +9408,66 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listOrganizationTeams`: { + `listGroupInvites`: { 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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `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.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, }, + `username`: { + Usage: `Email address of the user account invited to this project.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listOrganizationUsers`: { + `listGroupLimits`: { 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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `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.`, - }, - `orgMembershipStatus`: { - Usage: `Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, }, - `username`: { - Usage: `Email address to filter users by. Not supported in deprecated versions.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `orgMembershipStatus`: `ACTIVE`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listOrganizations`: { - 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.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `name`: { - Usage: `Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: nil, - }, - `listPeeringConnections`: { + `listGroupPeers`: { 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.`, @@ -9415,8 +9504,11 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listPeeringContainerByCloudProvider`: { + `listGroupPipelineRuns`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `createdBefore`: { + Usage: `If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.`, + }, `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.`, }, @@ -9434,12 +9526,12 @@ var metadata = metadatatypes.Metadata{ `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `providerName`: { - Usage: `Cloud service provider that serves the desired network peering containers.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ @@ -9447,13 +9539,13 @@ var metadata = metadatatypes.Metadata{ Flags: map[string]string{ `groupId`: `32b6e34b3d91647abb20e7b8`, - `providerName`: `[providerName]`, + `pipelineName`: `[pipelineName]`, }, }, }, }, }, - `listPeeringContainers`: { + `listGroupPipelines`: { 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.`, @@ -9463,14 +9555,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + }, + `listGroupPrivateEndpointEndpointService`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `cloudProvider`: { + Usage: `Cloud service provider that manages this private endpoint service.`, + }, + `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.`, @@ -9481,22 +9589,25 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `cloudProvider`: `[cloudProvider]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listPendingInvoices`: { + `listGroupPrivateEndpointServerlessInstanceEndpoint`: { 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.`, + `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.`, + `instanceName`: { + Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -9504,17 +9615,15 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `instanceName`: `[instanceName]`, }, }, }, }, }, - `listPipelineRuns`: { + `listGroupPrivateNetworkSettingEndpointIds`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `createdBefore`: { - Usage: `If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.`, - }, `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.`, }, @@ -9532,9 +9641,6 @@ var metadata = metadatatypes.Metadata{ `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -9544,15 +9650,23 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listPipelineSchedules`: { + `listGroupProcessCollStatMeasurements`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `collectionName`: { + Usage: `Human-readable label that identifies the collection.`, + }, + `databaseName`: { + Usage: `Human-readable label that identifies the database.`, + }, + `end`: { + Usage: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, + }, `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.`, }, @@ -9561,30 +9675,36 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + `metrics`: { + Usage: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `period`: { + Usage: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.`, + }, + `processId`: { + Usage: `Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, + `start`: { + Usage: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-11-15`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, + `collectionName`: `mycoll`, + `databaseName`: `mydb`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `period`: `PT10H`, + `processId`: `my.host.name.com:27017`, }, }, }, }, }, - `listPipelineSnapshots`: { + `listGroupProcessDatabases`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `completedAfter`: { - Usage: `Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.`, - }, `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.`, }, @@ -9602,26 +9722,26 @@ var metadata = metadatatypes.Metadata{ `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (` + "`" + `mongod` + "`" + `). The port must be the IANA port on which the MongoDB process listens for requests.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `pipelineName`: `[pipelineName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `listPipelines`: { + `listGroupProcessDisks`: { 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.`, @@ -9631,22 +9751,41 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `processId`: { + Usage: `Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) 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.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `mongodb.example.com:27017`, }, }, }, }, }, - `listPrivateEndpointServices`: { + `listGroupProcessPerformanceAdvisorNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `cloudProvider`: { - Usage: `Cloud service provider that manages this private endpoint service.`, + `duration`: { + Usage: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. + +- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. +- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, }, `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.`, @@ -9659,21 +9798,36 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `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.`, + }, + `since`: { + Usage: `Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. +- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `cloudProvider`: `[cloudProvider]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `[processId]`, }, }, }, }, }, - `listPrivateLinkConnections`: { + `listGroupProcessPerformanceAdvisorSlowQueryLogs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `duration`: { + Usage: `Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. + +- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. +- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, + }, `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.`, }, @@ -9682,29 +9836,54 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, + `includeMetrics`: { + Usage: `Whether or not to include metrics extracted from the slow query log as separate fields.`, }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `includeOpType`: { + Usage: `Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field.`, + }, + `includeReplicaState`: { + Usage: `Whether or not to include the replica state of the host when the slow query log was generated as a separate field.`, + }, + `nLogs`: { + Usage: `Maximum number of lines from the log to return.`, + }, + `namespaces`: { + Usage: `Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `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.`, + }, + `since`: { + Usage: `Date and time from which the query retrieves the slow queries. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. +- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `[processId]`, }, }, }, }, }, - `listProjectApiKeys`: { + `listGroupProcessPerformanceAdvisorSuggestedIndexes`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `duration`: { + Usage: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. + +- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. +- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, + }, `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.`, }, @@ -9719,42 +9898,48 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, + `nExamples`: { + Usage: `Maximum number of example queries that benefit from the suggested index.`, + }, + `nIndexes`: { + Usage: `Number that indicates the maximum indexes to suggest.`, + }, + `namespaces`: { + Usage: `Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, + }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processId`: { + Usage: `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.`, + }, + `since`: { + Usage: `Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. +- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processId`: `[processId]`, }, }, }, }, }, - `listProjectEvents`: { + `listGroupProcesses`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterNames`: { - 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.`, }, - `eventType`: { - Usage: `Category of incident recorded at this moment in time. - -**IMPORTANT**: The complete list of event type values changes frequently.`, - }, - `excludedEventType`: { - Usage: `Category of event that you would like to exclude from query results, such as CLUSTER_CREATED - -**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.`, - }, `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. @@ -9763,18 +9948,9 @@ var metadata = metadatatypes.Metadata{ `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - `includeRaw`: { - Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `maxDate`: { - Usage: `Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, - }, - `minDate`: { - Usage: `Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -9784,17 +9960,22 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `-`, + Source: `list_atlas_processes`, + Name: `List all processes for a project`, + Description: `Returns details of all processes for the specified project`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `[your-project-id]`, }, }, }, }, }, - `listProjectInvitations`: { + `listGroupServerlessBackupRestoreJobs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the serverless instance.`, + }, `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.`, }, @@ -9803,26 +9984,36 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `username`: { - Usage: `Email address of the user account invited to this project.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listProjectIpAccessLists`: { + `listGroupServerlessBackupSnapshots`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the serverless instance.`, + }, `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.`, }, @@ -9846,18 +10037,17 @@ var metadata = metadatatypes.Metadata{ }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ - Source: `project_ip_access_list_list`, - Name: `Return project IP access list`, - Description: `Returns all access list entries from the specified project's IP access list.`, + Source: `-`, Flags: map[string]string{ - `groupId`: `[your-project-id]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listProjectLimits`: { + `listGroupServerlessInstances`: { 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.`, @@ -9867,6 +10057,15 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, @@ -9882,7 +10081,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listProjectServiceAccountAccessList`: { + `listGroupServiceAccountAccessList`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clientId`: { Usage: `The Client ID of the Service Account.`, @@ -9920,7 +10119,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listProjectServiceAccounts`: { + `listGroupServiceAccounts`: { 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.`, @@ -9951,7 +10150,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listProjectTeams`: { + `listGroupStreamActiveVpcPeeringConnections`: { 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.`, @@ -9961,9 +10160,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -9975,7 +10171,7 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-11-13`: {{ Source: `-`, Flags: map[string]string{ @@ -9985,85 +10181,43 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listProjectUsers`: { + `listGroupStreamConnections`: { 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.`, }, - `flattenTeams`: { - Usage: `Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If ` + "`" + `"flattenTeams" : false` + "`" + `, this resource returns only users with a role in the project. If ` + "`" + `"flattenTeams" : true` + "`" + `, this resource returns both users with roles in the project and users who belong to teams with roles in the project.`, - }, `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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `includeOrgUsers`: { - Usage: `Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If ` + "`" + `"includeOrgUsers": false` + "`" + `, this resource returns only users with a role in the project. If ` + "`" + `"includeOrgUsers": true` + "`" + `, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `orgMembershipStatus`: { - Usage: `Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `username`: { - Usage: `Email address to filter users by. Not supported in deprecated versions.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `orgMembershipStatus`: `ACTIVE`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `listProjects`: { + `listGroupStreamPrivateLinkConnections`: { 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.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `list_projects`, - Name: `Get a list of all projects`, - Description: `Get a list of all projects inside of the organisation`, - }, - }, - }, - }, - `listReplicaSetBackups`: { - 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.`, }, @@ -10072,9 +10226,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -10086,69 +10237,18 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, - `listRoleMappings`: { - 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.`, - }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `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.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `orgId`: `4888442a3354817a7320eb61`, - }, - }, - }, - }, - }, - `listSchemaAdvice`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, - }, - `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.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listServerlessBackupRestoreJobs`: { + `listGroupStreamVpcPeeringConnections`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the serverless instance.`, - }, `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.`, }, @@ -10157,9 +10257,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -10169,24 +10266,24 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `requesterAccountId`: { + Usage: `The Account ID of the VPC Peering connection/s.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `requesterAccountId`: `[requesterAccountId]`, }, }, }, }, }, - `listServerlessBackups`: { + `listGroupStreamWorkspaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the serverless instance.`, - }, `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.`, }, @@ -10195,9 +10292,6 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -10209,18 +10303,17 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2023-02-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `listServerlessInstances`: { + `listGroupTeams`: { 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.`, @@ -10254,37 +10347,55 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listServerlessPrivateEndpoints`: { + `listGroupUsers`: { 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.`, }, + `flattenTeams`: { + Usage: `Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If ` + "`" + `"flattenTeams" : false` + "`" + `, this resource returns only users with a role in the project. If ` + "`" + `"flattenTeams" : true` + "`" + `, this resource returns both users with roles in the project and users who belong to teams with roles in the project.`, + }, `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.`, }, - `instanceName`: { - Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `includeOrgUsers`: { + Usage: `Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If ` + "`" + `"includeOrgUsers": false` + "`" + `, this resource returns only users with a role in the project. If ` + "`" + `"includeOrgUsers": true` + "`" + `, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `orgMembershipStatus`: { + Usage: `Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `username`: { + Usage: `Email address to filter users by. Not supported in deprecated versions.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `instanceName`: `[instanceName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgMembershipStatus`: `ACTIVE`, }, }, }, }, }, - `listServiceAccountAccessList`: { + `listGroups`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -10294,9 +10405,6 @@ var metadata = metadatatypes.Metadata{ `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `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.`, - }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -10305,25 +10413,25 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, - - Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `orgId`: `4888442a3354817a7320eb61`, - }, + `2023-01-01`: {{ + Source: `list_projects`, + Name: `Get a list of all projects`, + Description: `Get a list of all projects inside of the organisation`, }, }, }, }, - `listServiceAccountProjects`: { + `listOrgApiKeyAccessListEntries`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.`, }, `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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -10338,22 +10446,25 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clientId`: `mdb_sa_id_1234567890abcdef12345678`, - `orgId`: `4888442a3354817a7320eb61`, + `apiUserId`: `[apiUserId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listServiceAccounts`: { + `listOrgApiKeys`: { 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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, @@ -10368,7 +10479,7 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ @@ -10378,47 +10489,36 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listShardedClusterBackups`: { + `listOrgEvents`: { 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. + `eventType`: { + Usage: `Category of incident recorded at this moment in time. -**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.`, +**IMPORTANT**: The complete list of event type values changes frequently.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, + `includeRaw`: { + Usage: `Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.`, }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - }, - }, - `listSharedClusterBackupRestoreJobs`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `maxDate`: { + Usage: `Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, }, - `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.`, + `minDate`: { + Usage: `Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.`, }, - `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.`, + `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.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -10429,296 +10529,206 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listSharedClusterBackups`: { + `listOrgInvites`: { 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.`, + `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.`, }, + `username`: { + Usage: `Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listSlowQueries`: { + `listOrgInvoicePending`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `duration`: { - Usage: `Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - -- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. -- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, - }, `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.`, - }, - `includeMetrics`: { - Usage: `Whether or not to include metrics extracted from the slow query log as separate fields.`, - }, - `includeOpType`: { - Usage: `Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field.`, - }, - `includeReplicaState`: { - Usage: `Whether or not to include the replica state of the host when the slow query log was generated as a separate field.`, - }, - `nLogs`: { - Usage: `Maximum number of lines from the log to return.`, - }, - `namespaces`: { - Usage: `Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, + `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.`, }, - `processId`: { - Usage: `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.`, - }, - `since`: { - Usage: `Date and time from which the query retrieves the slow queries. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. -- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `[processId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listSlowQueryNamespaces`: { + `listOrgInvoices`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `duration`: { - Usage: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - -- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. -- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, - }, `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.`, - }, - `processId`: { - Usage: `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.`, - }, - `since`: { - Usage: `Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. -- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, + `fromDate`: { + Usage: `Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `[processId]`, - }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - }, - }, - `listSourceProjects`: { - 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.`, + `orderBy`: { + Usage: `Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.`, }, `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.`, }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `sortBy`: { + Usage: `Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.`, + }, + `statusNames`: { + Usage: `Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.`, + }, + `toDate`: { + Usage: `Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.`, + }, + `viewLinkedInvoices`: { + Usage: `Flag that indicates whether to return linked invoices in the linkedInvoices field.`, + }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, + `fromDate`: `2023-01-01`, + `orderBy`: `desc`, + `orgId`: `4888442a3354817a7320eb61`, + `toDate`: `2023-01-01`, }, }, }, }, }, - `listStreamConnections`: { + `listOrgLiveMigrationAvailableProjects`: { 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.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listStreamInstances`: { + `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.`, }, - `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.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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{ - `2023-02-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listStreamProcessors`: { + `listOrgServiceAccountAccessList`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clientId`: { + Usage: `The Client ID of the Service Account.`, + }, `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.`, - }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, + `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.`, + }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `clientId`: `mdb_sa_id_1234567890abcdef12345678`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listSuggestedIndexes`: { + `listOrgServiceAccounts`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `duration`: { - Usage: `Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - -- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. -- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.`, - }, `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.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, - `nExamples`: { - Usage: `Maximum number of example queries that benefit from the suggested index.`, - }, - `nIndexes`: { - Usage: `Number that indicates the maximum indexes to suggest.`, - }, - `namespaces`: { - Usage: `Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as ` + "`" + `.` + "`" + `: ` + "`" + `.` + "`" + `. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (` + "`" + `&` + "`" + `) between each namespace. Omit this parameter to return results for all namespaces.`, + `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.`, }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, @@ -10726,29 +10736,19 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processId`: { - Usage: `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.`, - }, - `since`: { - Usage: `Date and time from which the query retrieves the suggested indexes. 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 **duration** parameter, the endpoint returns data covering from the **since** value and the current time. -- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.`, - }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processId`: `[processId]`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `listTeamUsers`: { + `listOrgTeamUsers`: { 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.`, @@ -10791,22 +10791,20 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listThirdPartyIntegrations`: { + `listOrgTeams`: { 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.`, - }, `includeCount`: { Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, `itemsPerPage`: { Usage: `Number of items that the response returns per page.`, }, + `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.`, + }, `pageNum`: { Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, @@ -10819,52 +10817,75 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `orgId`: `4888442a3354817a7320eb61`, }, }, }, }, }, - `loadSampleDataset`: { + `listOrgUsers`: { 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - `name`: { - Usage: `Human-readable label that identifies the cluster into which you load the sample dataset.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `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.`, + }, + `orgMembershipStatus`: { + Usage: `Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + `username`: { + Usage: `Email address to filter users by. Not supported in deprecated versions.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `name`: `[name]`, + `orgId`: `4888442a3354817a7320eb61`, + `orgMembershipStatus`: `ACTIVE`, }, }, }, }, }, - `migrateProjectToAnotherOrg`: { + `listOrgs`: { 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.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `name`: { + Usage: `Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `modifyStreamProcessor`: { + `migrateGroup`: { 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.`, @@ -10874,19 +10895,10 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: nil, }, - `pausePipeline`: { + `pauseGroupPipeline`: { 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.`, @@ -10915,26 +10927,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `pinFeatureCompatibilityVersion`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies this 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.`, - }, - }, - Examples: nil, - }, - `pinNamespacesPatch`: { + `pinGroupClusterCollStatPinnedNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Human-readable label that identifies the cluster to pin namespaces to.`, @@ -10950,10 +10943,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `pinNamespacesPut`: { + `pinGroupClusterFeatureCompatibilityVersion`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster to pin namespaces to.`, + Usage: `Human-readable label that identifies this 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.`, @@ -10963,30 +10956,13 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - }, - Examples: nil, - }, - `queryLineItemsFromSingleInvoice`: { - 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.`, - }, - `invoiceId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `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.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `rejectVpcPeeringConnection`: { + `rejectGroupStreamVpcPeeringConnection`: { 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.`, @@ -11012,7 +10988,7 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `removeConnectedOrgConfig`: { + `removeFederationSettingConnectedOrgConfig`: { 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.`, @@ -11036,55 +11012,63 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `removeOrganizationRole`: { + `removeGroupApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, + }, `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.`, + `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.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `apiUserId`: `[apiUserId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, }, }, - Examples: nil, }, - `removeOrganizationUser`: { + `removeGroupTeam`: { 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.`, + `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.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by username.`, + `teamId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `orgId`: `4888442a3354817a7320eb61`, - `userId`: `[userId]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `teamId`: `[teamId]`, }, }, }, }, }, - `removeProjectApiKey`: { + `removeGroupUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, - }, `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.`, }, @@ -11096,20 +11080,23 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by username.`, + }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ - `apiUserId`: `[apiUserId]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `userId`: `[userId]`, }, }, }, }, }, - `removeProjectRole`: { + `removeGroupUserRole`: { 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.`, @@ -11128,62 +11115,55 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `removeProjectTeam`: { + `removeOrgTeamUser`: { 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.`, - }, - `teamId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.`, + `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.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `teamId`: `[teamId]`, - }, + `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 to remove the MongoDB user from.`, }, }, + Examples: nil, }, - `removeProjectUser`: { + `removeOrgTeamUserFromTeam`: { 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.`, + `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.`, }, + `teamId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.`, + }, `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers) resource and filter by username.`, + Usage: `Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2025-02-19`: {{ + `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `userId`: `[userId]`, + `orgId`: `4888442a3354817a7320eb61`, + `teamId`: `[teamId]`, + `userId`: `[userId]`, }, }, }, }, }, - `removeTeamUser`: { + `removeOrgUser`: { 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.`, @@ -11194,27 +11174,23 @@ var metadata = metadatatypes.Metadata{ `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 from which you want to remove one database application user.`, - }, `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.`, + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the [Return All MongoDB Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) resource and filter by username.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2025-02-19`: {{ Source: `-`, Flags: map[string]string{ `orgId`: `4888442a3354817a7320eb61`, - `teamId`: `[teamId]`, `userId`: `[userId]`, }, }, }, }, }, - `removeUserFromTeam`: { + `removeOrgUserRole`: { 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.`, @@ -11225,13 +11201,13 @@ var metadata = metadatatypes.Metadata{ `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 to remove the MongoDB user from.`, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, }, }, Examples: nil, }, - `renameTeam`: { + `renameOrgTeam`: { 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.`, @@ -11248,7 +11224,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `requestEncryptionAtRestPrivateEndpointDeletion`: { + `requestGroupEncryptionAtRestPrivateEndpointDeletion`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `cloudProvider`: { Usage: `Human-readable label that identifies the cloud provider of the private endpoint to delete.`, @@ -11281,7 +11257,33 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `resetMaintenanceWindow`: { + `requestGroupSampleDatasetLoad`: { + 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.`, + }, + `name`: { + Usage: `Human-readable label that identifies the cluster into which you load the sample dataset.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + `name`: `[name]`, + }, + }, + }, + }, + }, + `resetGroupMaintenanceWindow`: { 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.`, @@ -11303,7 +11305,36 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `resumePipeline`: { + `restartGroupClusterPrimaries`: { + 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.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-02-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, + }, + `resumeGroupPipeline`: { 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.`, @@ -11332,16 +11363,35 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `returnAllControlPlaneIpAddresses`: { + `revokeFederationSettingIdentityProviderJwks`: { 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.`, }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `identityProviderId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the identity provider to connect.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2023-11-15`: {{ + Source: `-`, + + Flags: map[string]string{ + `federationSettingsId`: `55fa922fb343282757d9554e`, + `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, }, - Examples: nil, }, - `returnAllIpAddresses`: { + `revokeGroupClusterMongoDbEmployeeAccess`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, }, @@ -11355,17 +11405,38 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-08-05`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `returnFederatedDatabaseQueryLimit`: { + `searchOrgInvoiceLineItems`: { + 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.`, + }, + `invoiceId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `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.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, + }, + Examples: nil, + }, + `setGroupDataFederationLimit`: { 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.`, @@ -11384,13 +11455,64 @@ var metadata = metadatatypes.Metadata{ | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | +`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, + }, + }, + Examples: nil, + }, + `setGroupLimit`: { + 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.`, + }, + `limitName`: { + Usage: `Human-readable label that identifies this project limit. + +| Limit Name | Description | Default | API Override Limit | +| --- | --- | --- | --- | +| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | +| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | +| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | +| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | +| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | +| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | +| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | +| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | +| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | +| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | +| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| +| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| `, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance to which the query limit applies.`, + }, + Examples: nil, + }, + `setGroupServerlessPerformanceAdvisorAutoIndexing`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster.`, + }, + `enable`: { + Usage: `Value that we want to set for the Serverless Auto Indexing toggle.`, + }, + `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.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -11398,15 +11520,34 @@ var metadata = metadatatypes.Metadata{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `limitName`: `[limitName]`, - `tenantName`: `[tenantName]`, + `clusterName`: `[clusterName]`, + `enable`: `[enable]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `returnFederatedDatabaseQueryLimits`: { + `startGroupClusterOutageSimulation`: { + Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster to undergo an outage simulation.`, + }, + `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.`, + }, + }, + Examples: nil, + }, + `startGroupStreamProcessor`: { 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.`, @@ -11419,50 +11560,85 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, + }, `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance for which you want to retrieve query limits.`, + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `tenantName`: `[tenantName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processorName`: `[processorName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `revokeJwksFromIdentityProvider`: { + `startGroupStreamProcessorWith`: { + 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.`, + }, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, + }, + }, + Examples: nil, + }, + `stopGroupStreamProcessor`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + `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.`, + }, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, }, - `identityProviderId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the identity provider to connect.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: map[string][]metadatatypes.Example{ - `2023-11-15`: {{ + `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `federationSettingsId`: `55fa922fb343282757d9554e`, - `identityProviderId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, + `processorName`: `[processorName]`, + `tenantName`: `[tenantName]`, }, }, }, }, }, - `revokeMongoDbEmployeeAccess`: { + `takeGroupClusterBackupSnapshots`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies this cluster.`, + 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.`, @@ -11476,20 +11652,29 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: map[string][]metadatatypes.Example{ - `2024-08-05`: {{ - Source: `-`, + Examples: nil, + }, + `tenantGroupFlexClusterUpgrade`: { + 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. - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, +**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.`, }, }, + Examples: nil, }, - `saveLdapConfiguration`: { + `toggleGroupAlertConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `alertConfigId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.`, + }, `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.`, }, @@ -11504,7 +11689,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `setProjectLimit`: { + `toggleGroupAwsCustomDns`: { 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.`, @@ -11513,26 +11698,6 @@ var metadata = metadatatypes.Metadata{ 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.`, - }, - `limitName`: { - Usage: `Human-readable label that identifies this project limit. - -| Limit Name | Description | Default | API Override Limit | -| --- | --- | --- | --- | -| atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | -| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | -| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | -| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | -| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | -| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | -| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | -| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | -| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | -| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | -| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| -| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| -| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | -`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -11540,41 +11705,30 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `setServerlessAutoIndexing`: { + `toggleGroupMaintenanceWindowAutoDefer`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, - }, - `enable`: { - Usage: `Value that we want to set for the Serverless Auto Indexing toggle.`, + `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.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2023-01-01`: {{ Source: `-`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `enable`: `[enable]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `startOutageSimulation`: { + `toggleGroupPrivateEndpointRegionalMode`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster to undergo an outage simulation.`, - }, `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.`, }, @@ -11589,7 +11743,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `startStreamProcessor`: { + `triggerGroupPipeline`: { 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.`, @@ -11599,31 +11753,20 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processorName`: `[processorName]`, - `tenantName`: `[tenantName]`, - }, - }, - }, }, + Examples: nil, }, - `startStreamProcessorWith`: { + `unpinGroupClusterCollStatUnpinNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies the cluster to unpin namespaces from.`, + }, `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.`, }, @@ -11632,20 +11775,14 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: nil, }, - `stopStreamProcessor`: { + `unpinGroupClusterFeatureCompatibilityVersion`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `clusterName`: { + Usage: `Human-readable label that identifies this 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.`, }, @@ -11657,50 +11794,66 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `processorName`: { - Usage: `Human-readable label that identifies the stream processor.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: map[string][]metadatatypes.Example{ `2024-05-30`: {{ Source: `-`, Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `processorName`: `[processorName]`, - `tenantName`: `[tenantName]`, + `clusterName`: `[clusterName]`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `takeSnapshot`: { + `updateFederationSettingConnectedOrgConfig`: { 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `orgId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.`, }, + }, + Examples: nil, + }, + `updateFederationSettingConnectedOrgConfigRoleMapping`: { + 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.`, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, }, - `pretty`: { - Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + `id`: { + Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.`, + }, + `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.`, }, }, Examples: nil, }, - `testFailover`: { + `updateFederationSettingIdentityProvider`: { 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.`, + }, + `federationSettingsId`: { + Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, + }, + `identityProviderId`: { + Usage: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, }, + }, + Examples: nil, + }, + `updateGroup`: { + 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.`, }, @@ -11714,21 +11867,30 @@ var metadata = metadatatypes.Metadata{ }, }, Examples: map[string][]metadatatypes.Example{ - `2023-02-01`: {{ - Source: `-`, - + `2023-01-01`: {{ + Source: `update_project`, + Name: `Update project name and tags`, + Description: `Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production"`, + Value: `{ + "name": "MongoTube - Production", + "tags": [ + { + "key": "environment", + "value": "production" + } + ] +}`, Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, + `groupId`: `32b6e34b3d91647abb20e7b8`, }, }, }, }, }, - `toggleAlertConfiguration`: { + `updateGroupAlertConfig`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `alertConfigId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.`, + Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, }, `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.`, @@ -11744,8 +11906,11 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `toggleAwsCustomDns`: { + `updateGroupApiKeyRoles`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, + }, `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.`, }, @@ -11754,13 +11919,22 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, + }, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, + }, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `toggleMaintenanceAutoDefer`: { + `updateGroupAuditLog`: { 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.`, @@ -11770,20 +11944,36 @@ var metadata = metadatatypes.Metadata{ **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.`, + }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, + Examples: nil, + }, + `updateGroupBackupCompliancePolicy`: { + 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. - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, +**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.`, + }, + `overwriteBackupPolicies`: { + Usage: `Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.`, }, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, + Examples: nil, }, - `toggleRegionalizedPrivateEndpointSetting`: { + `updateGroupCluster`: { 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.`, }, @@ -11792,14 +11982,46 @@ var metadata = metadatatypes.Metadata{ **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.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, + }, + }, + Examples: map[string][]metadatatypes.Example{ + `2024-10-23`: {{ + Source: `update_cluster`, + Name: `Update a cluster's configuration`, + Description: `Updates the cluster to increase disk size to 20GB and increase node count to 5`, + Value: `{ + "replicationSpecs": [ + { + "regionConfigs": [ + { + "electableSpecs": { + "diskSizeGB": 20, + "instanceSize": "M10", + "nodeCount": 5 + }, + "priority": 7, + "providerName": "AWS", + "regionName": "US_EAST_1" + } + ] + } + ] +}`, + Flags: map[string]string{ + `clusterName`: `[your-cluster-name]`, + `groupId`: `[your-project-id]`, + }, + }, }, }, - Examples: nil, }, - `triggerSnapshotIngestion`: { + `updateGroupClusterBackupSchedule`: { 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.`, }, @@ -11808,19 +12030,16 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `unpinFeatureCompatibilityVersion`: { + `updateGroupClusterBackupSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies this cluster.`, + 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.`, @@ -11833,23 +12052,16 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-05-30`: {{ - Source: `-`, - - Flags: map[string]string{ - `clusterName`: `[clusterName]`, - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, + Examples: nil, }, - `unpinNamespaces`: { + `updateGroupClusterCollStatPinnedNamespaces`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster to unpin namespaces from.`, + Usage: `Human-readable label that identifies the cluster to pin namespaces to.`, }, `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.`, @@ -11862,10 +12074,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateAlertConfiguration`: { + `updateGroupClusterFtsIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `alertConfigId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the alert configuration.`, + `clusterName`: { + Usage: `Name of the cluster that contains the collection whose Atlas Search index to update.`, }, `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.`, @@ -11875,22 +12087,30 @@ var metadata = metadatatypes.Metadata{ **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.`, }, + `indexId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.`, + }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `updateApiKey`: { + `updateGroupClusterOnlineArchive`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key you want to update.`, + `archiveId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the online archive to update.`, + }, + `clusterName`: { + Usage: `Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.`, }, `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.`, + `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.`, @@ -11898,10 +12118,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateApiKeyRoles`: { + `updateGroupClusterProcessArgs`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `apiUserId`: { - Usage: `Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.`, + `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.`, @@ -11911,22 +12131,13 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `updateAtlasSearchDeployment`: { + `updateGroupClusterSearchDeployment`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Label that identifies the cluster to update the Search Nodes for.`, @@ -11945,7 +12156,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateAtlasSearchIndex`: { + `updateGroupClusterSearchIndex`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Name of the cluster that contains the collection whose Atlas Search index you want to update.`, @@ -11967,7 +12178,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateAtlasSearchIndexByName`: { + `updateGroupClusterSearchIndexByName`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { Usage: `Name of the cluster that contains the collection whose Atlas Search index you want to update.`, @@ -11995,10 +12206,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateAtlasSearchIndexDeprecated`: { + `updateGroupClusterSnapshot`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Name of the cluster that contains the collection whose Atlas Search index to update.`, + 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.`, @@ -12008,35 +12219,19 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `indexId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - }, - Examples: nil, - }, - `updateAuditingConfiguration`: { - 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.`, + `snapshotId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, }, }, Examples: nil, }, - `updateBackupSchedule`: { + `updateGroupClusterSnapshotSchedule`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, }, `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.`, @@ -12052,58 +12247,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateCluster`: { - 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.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `2024-10-23`: {{ - Source: `update_cluster`, - Name: `Update a cluster's configuration`, - Description: `Updates the cluster to increase disk size to 20GB and increase node count to 5`, - Value: `{ - "replicationSpecs": [ - { - "regionConfigs": [ - { - "electableSpecs": { - "diskSizeGB": 20, - "instanceSize": "M10", - "nodeCount": 5 - }, - "priority": 7, - "providerName": "AWS", - "regionName": "US_EAST_1" - } - ] - } - ] -}`, - Flags: map[string]string{ - `clusterName`: `[your-cluster-name]`, - `groupId`: `[your-project-id]`, - }, - }, - }, - }, - }, - `updateClusterAdvancedConfiguration`: { + `updateGroupContainer`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster.`, + `containerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, }, `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.`, @@ -12119,21 +12266,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateConnectedOrgConfig`: { - 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.`, - }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `orgId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.`, - }, - }, - Examples: nil, - }, - `updateCustomDatabaseRole`: { + `updateGroupCustomDbRoleRole`: { 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.`, @@ -12152,7 +12285,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateDataProtectionSettings`: { + `updateGroupDataFederation`: { 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.`, @@ -12162,16 +12295,19 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `overwriteBackupPolicies`: { - Usage: `Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.`, - }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `skipRoleValidation`: { + Usage: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, + }, + `tenantName`: { + Usage: `Human-readable label that identifies the federated database instance to update.`, + }, }, Examples: nil, }, - `updateDatabaseUser`: { + `updateGroupDatabaseUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `databaseName`: { Usage: `The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be ` + "`" + `$external` + "`" + `. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be ` + "`" + `admin` + "`" + `.`, @@ -12206,23 +12342,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateEncryptionAtRest`: { - 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.`, - }, - }, - Examples: nil, - }, - `updateFederatedDatabase`: { + `updateGroupEncryptionAtRest`: { 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.`, @@ -12235,16 +12355,10 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `skipRoleValidation`: { - Usage: `Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.`, - }, - `tenantName`: { - Usage: `Human-readable label that identifies the federated database instance to update.`, - }, }, Examples: nil, }, - `updateFlexCluster`: { + `updateGroupFlexCluster`: { 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.`, @@ -12263,25 +12377,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateIdentityProvider`: { + `updateGroupIntegration`: { 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.`, - }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `identityProviderId`: { - Usage: `Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.`, - }, - }, - Examples: nil, - }, - `updateLegacySnapshotRetention`: { - 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.`, }, @@ -12290,27 +12387,17 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `includeCount`: { + Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, }, - }, - Examples: nil, - }, - `updateLegacySnapshotSchedule`: { - Parameters: map[string]metadatatypes.ParameterMetadata{ - `clusterName`: { - Usage: `Human-readable label that identifies the cluster with the snapshot you want to return.`, + `integrationType`: { + Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, }, - `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.`, + `itemsPerPage`: { + Usage: `Number of items that the response returns per page.`, }, - `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.`, + `pageNum`: { + Usage: `Number of the page that displays the current set of the total objects that the response returns.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -12318,27 +12405,8 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateMaintenanceWindow`: { - 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.`, - }, - }, - Examples: nil, - }, - `updateOnlineArchive`: { + `updateGroupInviteById`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `archiveId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the online archive to update.`, - }, - `clusterName`: { - Usage: `Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.`, - }, `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.`, }, @@ -12347,36 +12415,21 @@ var metadata = metadatatypes.Metadata{ **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.`, - }, - }, - 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.`, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, }, }, Examples: nil, }, - `updateOrganization`: { + `updateGroupInvites`: { 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.`, + `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.`, @@ -12384,30 +12437,31 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateOrganizationInvitation`: { + `updateGroupMaintenanceWindow`: { 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.`, + `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.`, }, }, Examples: nil, }, - `updateOrganizationInvitationById`: { + `updateGroupPeer`: { 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.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + `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.`, }, - `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.`, + `peerId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -12415,55 +12469,58 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateOrganizationRoles`: { + `updateGroupPipeline`: { 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.`, + `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.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + `pipelineName`: { + Usage: `Human-readable label that identifies the Data Lake Pipeline.`, }, }, Examples: nil, }, - `updateOrganizationSettings`: { + `updateGroupPrivateEndpointServerlessInstanceEndpoint`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `endpointId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.`, + }, `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.`, + `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.`, + `instanceName`: { + Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.`, }, }, Examples: nil, }, - `updateOrganizationUser`: { + `updateGroupPushBasedLogExport`: { 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.`, + `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.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, - }, }, Examples: nil, }, - `updatePeeringConnection`: { + `updateGroupServerlessInstance`: { 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.`, @@ -12473,8 +12530,8 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `peerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.`, + `name`: { + Usage: `Human-readable label that identifies the serverless instance.`, }, `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, @@ -12482,10 +12539,10 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updatePeeringContainer`: { + `updateGroupServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `containerId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, @@ -12501,7 +12558,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updatePipeline`: { + `updateGroupSettings`: { 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.`, @@ -12511,14 +12568,17 @@ var metadata = metadatatypes.Metadata{ **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.`, }, - `pipelineName`: { - Usage: `Human-readable label that identifies the Data Lake Pipeline.`, + `pretty`: { + Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, Examples: nil, }, - `updateProject`: { + `updateGroupStreamConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `connectionName`: { + Usage: `Human-readable label that identifies the stream connection.`, + }, `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.`, }, @@ -12530,29 +12590,13 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `update_project`, - Name: `Update project name and tags`, - Description: `Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production"`, - Value: `{ - "name": "MongoTube - Production", - "tags": [ - { - "key": "environment", - "value": "production" - } - ] -}`, - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, + Examples: nil, }, - `updateProjectInvitation`: { + `updateGroupStreamProcessor`: { 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.`, @@ -12565,26 +12609,16 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - }, - Examples: nil, - }, - `updateProjectInvitationById`: { - 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.`, + `processorName`: { + Usage: `Human-readable label that identifies the stream processor.`, }, - `invitationId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance.`, }, }, Examples: nil, }, - `updateProjectRoles`: { + `updateGroupStreamWorkspace`: { 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.`, @@ -12597,17 +12631,14 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, - `userId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + `tenantName`: { + Usage: `Human-readable label that identifies the stream instance to update.`, }, }, Examples: nil, }, - `updateProjectServiceAccount`: { + `updateGroupTeam`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -12619,10 +12650,13 @@ var metadata = metadatatypes.Metadata{ `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 update roles.`, + }, }, Examples: nil, }, - `updateProjectSettings`: { + `updateGroupUserRoles`: { 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.`, @@ -12635,10 +12669,13 @@ var metadata = metadatatypes.Metadata{ `pretty`: { Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + }, }, Examples: nil, }, - `updatePushBasedLogConfiguration`: { + `updateGroupUserSecurity`: { 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.`, @@ -12654,35 +12691,30 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateRoleMapping`: { + `updateOrg`: { 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.`, }, - `federationSettingsId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your federation.`, - }, - `id`: { - Usage: `Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.`, - }, `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, }, - `updateServerlessInstance`: { + `updateOrgApiKey`: { Parameters: map[string]metadatatypes.ParameterMetadata{ + `apiUserId`: { + Usage: `Unique 24-hexadecimal digit string that identifies this organization API key you want to update.`, + }, `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.`, - }, - `name`: { - Usage: `Human-readable label that identifies the serverless instance.`, + `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.`, @@ -12690,30 +12722,25 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateServerlessPrivateEndpoint`: { + `updateOrgInviteById`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `endpointId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.`, - }, `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.`, + `invitationId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the invitation.`, }, - `instanceName`: { - Usage: `Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.`, + `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, }, - `updateServiceAccount`: { + `updateOrgInvites`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `clientId`: { - Usage: `The Client ID of the Service Account.`, - }, `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.`, }, @@ -12726,117 +12753,89 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `updateSnapshotRetention`: { + `updateOrgResourcePolicy`: { 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.`, + `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.`, }, - `snapshotId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the desired snapshot.`, + `resourcePolicyId`: { + Usage: `Unique 24-hexadecimal digit string that identifies an atlas resource policy.`, }, }, Examples: nil, }, - `updateStreamConnection`: { + `updateOrgServiceAccount`: { Parameters: map[string]metadatatypes.ParameterMetadata{ - `connectionName`: { - Usage: `Human-readable label that identifies the stream connection.`, + `clientId`: { + Usage: `The Client ID of the Service Account.`, }, `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.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance.`, - }, }, Examples: nil, }, - `updateStreamInstance`: { + `updateOrgSettings`: { 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.`, + `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.`, }, - `tenantName`: { - Usage: `Human-readable label that identifies the stream instance to update.`, - }, }, Examples: nil, }, - `updateTeamRoles`: { + `updateOrgUser`: { 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.`, + `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.`, }, - `teamId`: { - Usage: `Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.`, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.`, }, }, Examples: nil, }, - `updateThirdPartyIntegration`: { + `updateOrgUserRoles`: { 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.`, - }, - `includeCount`: { - Usage: `Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.`, - }, - `integrationType`: { - Usage: `Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, + `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.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string that identifies the user to modify.`, + }, }, Examples: nil, }, - `upgradeFlexCluster`: { + `upgradeGroupClusterTenantUpgrade`: { 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.`, @@ -12852,7 +12851,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `upgradeSharedCluster`: { + `upgradeGroupClusterTenantUpgradeToServerless`: { 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.`, @@ -12868,7 +12867,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `upgradeSharedClusterToServerless`: { + `validateGroupLiveMigrations`: { 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.`, @@ -12884,7 +12883,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `validateAtlasResourcePolicy`: { + `validateOrgResourcePolicies`: { 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.`, @@ -12898,7 +12897,7 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `validateMigration`: { + `verifyGroupPrivateIpMode`: { 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.`, @@ -12912,9 +12911,18 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: nil, + Examples: map[string][]metadatatypes.Example{ + `2023-01-01`: {{ + Source: `-`, + + Flags: map[string]string{ + `groupId`: `32b6e34b3d91647abb20e7b8`, + }, + }, + }, + }, }, - `verifyConnectViaPeeringOnlyModeForOneProject`: { + `verifyGroupUserSecurityLdap`: { 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.`, @@ -12928,18 +12936,9 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, }, - Examples: map[string][]metadatatypes.Example{ - `2023-01-01`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, + Examples: nil, }, - `verifyLdapConfiguration`: { + `withGroupStreamSampleConnections`: { 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.`, diff --git a/tools/internal/specs/overlays/watchers.yaml b/tools/internal/specs/overlays/watchers.yaml index 78544ebab6..3907e490c8 100644 --- a/tools/internal/specs/overlays/watchers.yaml +++ b/tools/internal/specs/overlays/watchers.yaml @@ -9,9 +9,8 @@ actions: watcher: get: version: "2024-08-05" - operation-id: getCluster + operation-id: createGroupCluster params: - clusterName: body:$.name groupId: body:$.groupId expect: match: @@ -23,8 +22,8 @@ actions: x-xgen-atlascli: watcher: get: - version: "2024-08-05" - operation-id: getCluster + version: "2023-01-01" + operation-id: deleteGroupCluster params: clusterName: input:clusterName groupId: input:groupId @@ -36,7 +35,7 @@ actions: watcher: get: version: "2024-08-05" - operation-id: getCluster + operation-id: updateGroupCluster params: clusterName: input:clusterName groupId: input:groupId @@ -51,7 +50,7 @@ actions: watcher: get: version: "2024-05-30" - operation-id: getAtlasSearchDeployment + operation-id: updateGroupClusterSearchDeployment params: clusterName: input:clusterName groupId: input:groupId @@ -66,7 +65,7 @@ actions: watcher: get: version: "2024-05-30" - operation-id: getAtlasSearchDeployment + operation-id: deleteGroupClusterSearchDeployment params: clusterName: input:clusterName groupId: input:groupId @@ -78,7 +77,7 @@ actions: watcher: get: version: "2023-10-01" - operation-id: getDataProtectionSettings + operation-id: updateGroupBackupCompliancePolicy params: groupId: input:groupId expect: @@ -92,10 +91,9 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getLdapConfigurationStatus + operation-id: verifyGroupUserSecurityLdap params: groupId: input:groupId - requestId: body:$.requestId expect: match: path: $.status @@ -107,11 +105,10 @@ actions: x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: createGroupServerlessInstance params: groupId: input:groupId - name: body:$.name expect: match: path: $.status @@ -122,8 +119,8 @@ actions: x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: updateGroupServerlessInstance params: groupId: input:groupId name: input:name @@ -137,8 +134,8 @@ actions: x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: deleteGroupServerlessInstance params: groupId: input:groupId name: input:name @@ -150,11 +147,10 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: takeGroupClusterBackupSnapshots params: groupId: input:groupId clusterName: input:clusterName - snapshotId: body:$.id expect: match: path: $.status @@ -167,7 +163,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: updateGroupClusterBackupSnapshot params: groupId: input:groupId clusterName: input:clusterName @@ -184,7 +180,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: deleteGroupClusterBackupSnapshot params: groupId: input:groupId clusterName: input:clusterName @@ -197,9 +193,8 @@ actions: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: createGroupFlexCluster params: - name: body:$.name groupId: body:$.groupId expect: match: @@ -212,9 +207,8 @@ actions: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: createGroupFlexCluster params: - name: body:$.name groupId: input:groupId expect: match: @@ -227,7 +221,7 @@ actions: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: updateGroupFlexCluster params: name: input:name groupId: input:groupId @@ -242,7 +236,7 @@ actions: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: deleteGroupFlexCluster params: name: input:name groupId: input:groupId @@ -254,11 +248,10 @@ actions: watcher: get: version: "2024-11-13" - operation-id: getFlexBackupRestoreJob + operation-id: createGroupFlexClusterBackupRestoreJob params: name: input:name groupId: input:groupId - restoreJobId: body:$.id expect: match: path: $.status @@ -271,11 +264,9 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getPrivateEndpointService + operation-id: createGroupPrivateEndpointEndpointService params: - cloudProvider: body:$.cloudProvider groupId: input:groupId - endpointServiceId: body:$.id expect: match: path: $.status @@ -288,7 +279,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getPrivateEndpointService + operation-id: deleteGroupPrivateEndpointEndpointService params: cloudProvider: body:$.cloudProvider groupId: input:groupId @@ -301,10 +292,9 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: createGroupPipeline params: groupId: input:groupId - pipelineName: body:$.name expect: match: path: $.state @@ -316,7 +306,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: updateGroupPipeline params: groupId: input:groupId pipelineName: input:pipelineName @@ -331,7 +321,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: deleteGroupPipeline params: groupId: input:groupId pipelineName: input:pipelineName @@ -343,11 +333,10 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getBackupExportJob + operation-id: createGroupClusterBackupExport params: groupId: input:groupId clusterName: input:clusterName - exportId: body:$.id expect: match: path: $.state @@ -361,10 +350,10 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getSampleDatasetLoadStatus + operation-id: requestGroupSampleDatasetLoad params: groupId: input:groupId - sampleDatasetId: body:$.id + name: input:name expect: match: path: $.state @@ -377,11 +366,10 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: createGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName - archiveId: body:$.id expect: match: path: $.state @@ -397,7 +385,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: updateGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName @@ -417,7 +405,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: deleteGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName @@ -430,7 +418,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getServerlessBackup + operation-id: createGroupServerlessBackupSnapshot params: groupId: input:groupId clusterName: input:clusterName @@ -447,7 +435,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getOutageSimulation + operation-id: startGroupClusterOutageSimulation params: groupId: input:groupId clusterName: input:clusterName @@ -462,7 +450,7 @@ actions: watcher: get: version: "2023-01-01" - operation-id: getOutageSimulation + operation-id: endGroupClusterOutageSimulation params: groupId: input:groupId clusterName: input:clusterName diff --git a/tools/internal/specs/spec-with-overlays.yaml b/tools/internal/specs/spec-with-overlays.yaml index 3e0d5603b5..ff402970fa 100644 --- a/tools/internal/specs/spec-with-overlays.yaml +++ b/tools/internal/specs/spec-with-overlays.yaml @@ -930,6 +930,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -971,6 +973,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -1092,10 +1096,12 @@ components: mapping: aws: '#/components/schemas/AWSAccountDetails' azure: '#/components/schemas/AzureAccountDetails' + gcp: '#/components/schemas/GCPAccountDetails' propertyName: cloudProvider oneOf: - $ref: '#/components/schemas/AWSAccountDetails' - $ref: '#/components/schemas/AzureAccountDetails' + - $ref: '#/components/schemas/GCPAccountDetails' type: object AcknowledgeAlert: description: Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean. @@ -3769,7 +3775,7 @@ components: - name type: object AtlasResourcePolicyAuditForNdsGroup: - description: Atlas resource policy audits indicate org level changes to resource policies + description: Atlas resource policy audits indicate organization level changes to resource policies. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -3873,7 +3879,7 @@ components: title: Atlas Resource Policy Audits For NDS Group type: object AtlasResourcePolicyAuditForOrg: - description: Atlas resource policy audits indicate org level changes to resource policies + description: Atlas resource policy audits indicate organization level changes to resource policies. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -4006,7 +4012,7 @@ components: title: Atlas Search Analyzer type: object AtlasTenantClusterUpgradeRequest20240805: - description: Request containing target state of tenant cluster to be upgraded + description: Request containing target state of tenant cluster to be upgraded. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -4120,6 +4126,14 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + internalClusterRole: + description: 'Internal classification of the cluster''s role. Possible values: NONE (regular user cluster), SYSTEM_CLUSTER (system cluster for backup), INTERNAL_SHADOW_CLUSTER (internal use shadow cluster for testing).' + enum: + - NONE + - SYSTEM_CLUSTER + - INTERNAL_SHADOW_CLUSTER + readOnly: true + type: string labels: deprecated: true description: |- @@ -5193,6 +5207,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -5234,6 +5250,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -6263,6 +6281,8 @@ components: - M400_NVME title: AWS Instance Sizes type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - enum: - M10 - M20 @@ -6288,6 +6308,8 @@ components: - M600_NVME title: Azure Instance Sizes type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - enum: - M10 - M20 @@ -7153,7 +7175,7 @@ components: - metricName type: object ChartsAudit: - description: Audit events related to Atlas Charts + description: Audit events related to Atlas Charts. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -8104,6 +8126,10 @@ components: AZURE: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' GCP: '#/components/schemas/CloudProviderAccessGCPServiceAccount' propertyName: providerName + oneOf: + - $ref: '#/components/schemas/CloudProviderAccessAWSIAMRole' + - $ref: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' + - $ref: '#/components/schemas/CloudProviderAccessGCPServiceAccount' properties: providerName: description: Human-readable label that identifies the cloud provider of the role. @@ -8332,6 +8358,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Microsoft Azure Regions. enum: - US_CENTRAL @@ -8389,6 +8417,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Google Compute Regions. enum: - EASTERN_US @@ -8443,6 +8473,8 @@ components: - ASIA_SOUTHEAST_2 title: GCP Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object title: Cloud Service Provider Settings for Multi-Cloud Clusters type: object @@ -8524,6 +8556,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Microsoft Azure Regions. enum: - US_CENTRAL @@ -8581,6 +8615,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Google Compute Regions. enum: - EASTERN_US @@ -8635,6 +8671,8 @@ components: - ASIA_SOUTHEAST_2 title: GCP Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object title: Cloud Service Provider Settings type: object @@ -9099,6 +9137,14 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + internalClusterRole: + description: 'Internal classification of the cluster''s role. Possible values: NONE (regular user cluster), SYSTEM_CLUSTER (system cluster for backup), INTERNAL_SHADOW_CLUSTER (internal use shadow cluster for testing).' + enum: + - NONE + - SYSTEM_CLUSTER + - INTERNAL_SHADOW_CLUSTER + readOnly: true + type: string labels: deprecated: true description: |- @@ -10338,7 +10384,7 @@ components: description: Request body for a cost explorer query. properties: clusters: - description: The list of projects to be included in the Cost Explorer Query. + description: The list of clusters to be included in the Cost Explorer Query. items: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ @@ -10374,7 +10420,7 @@ components: type: string type: array services: - description: The list of projects to be included in the Cost Explorer Query. + description: The list of SKU services to be included in the Cost Explorer Query. items: enum: - Atlas @@ -10508,7 +10554,7 @@ components: title: AWS type: object CreateAtlasOrganizationApiKey: - description: Details of the programmatic API key to be created. + description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request. properties: desc: description: Purpose or explanation provided when someone created this organization API key. @@ -10838,11 +10884,23 @@ components: description: 'MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can''t use the empty document (`{}`) to return all documents. Set this parameter when **"criteria.type" : "CUSTOM"**.' type: string type: object - description: '**CUSTOM criteria.type**.' + description: Custom archival criteria. required: - query title: Archival Criteria type: object + CustomSessionTimeouts: + description: Defines the session timeout settings for managing user sessions at the organization level. When set to null, the field's value is unset, and the default timeout settings are applied. + properties: + absoluteSessionTimeoutInSeconds: + description: Specifies the absolute session timeout duration in seconds. When set to null, the field's value is unset, and the default value of 43,200 seconds (12 hours) is applied. Accepted values range between a minimum of 3,600 seconds (1 hour) and a maximum of 43,200 seconds (12 hours). + format: int32 + type: integer + idleSessionTimeoutInSeconds: + description: 'Specifies the idle session timeout duration in seconds. When set to null, the field''s value is unset, and the default behavior depends on the context: no timeout for Atlas Commercial, and 600 seconds (10 minutes) for Atlas for Government. Accepted values start at a minimum of 300 seconds (5 minutes). For Atlas Commercial, the maximum value cannot exceed the configured absolute session timeout. For Atlas for Government, the maximum value is capped at 600 seconds (10 minutes).' + format: int32 + type: integer + type: object CustomZoneMappings: properties: customZoneMappings: @@ -11235,7 +11293,6 @@ components: mapping: atlas.project.deployment.clusters: '#/components/schemas/DefaultLimit' atlas.project.deployment.nodesPerPrivateLinkRegion: '#/components/schemas/DefaultLimit' - atlas.project.deployment.salesSoldM0s: '#/components/schemas/DefaultLimit' atlas.project.deployment.serverlessMTMs: '#/components/schemas/DefaultLimit' atlas.project.security.databaseAccess.customRoles: '#/components/schemas/DefaultLimit' atlas.project.security.databaseAccess.users: '#/components/schemas/DefaultLimit' @@ -12819,6 +12876,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 + sendQueryStatsMetrics: + default: false + description: Toggle sending query shape metrics that includes query hash and metrics on latency, execution frequency, documents returned, and timestamps. + type: boolean sendUserProvidedResourceTags: default: false description: Toggle sending user provided group and cluster resource tags with the datadog metrics. @@ -12939,7 +13000,7 @@ components: format: int32 type: integer type: object - description: '**DATE criteria.type**.' + description: Date-Based archival criteria. title: Archival Criteria type: object DbDataSizeTotalDataMetricThresholdView: @@ -13137,6 +13198,8 @@ components: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13342,6 +13405,8 @@ components: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13561,6 +13626,7 @@ components: - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES + - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA title: Cluster Connection Audit Types type: string - enum: @@ -13668,6 +13734,10 @@ components: - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - ENCRYPTION_AT_REST_CONFIG_IS_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13835,6 +13905,11 @@ components: - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS title: Access Event Types type: string + - enum: + - QUERY_SHAPE_BLOCKED + - QUERY_SHAPE_UNBLOCKED + title: Query Shape Event Types + type: string type: object groupId: description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. @@ -13948,6 +14023,8 @@ components: - ROLE_MAPPING_DELETED title: Federation Settings Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - GROUP_DELETED - GROUP_CREATED @@ -14065,7 +14142,7 @@ components: title: Any Other Events type: object DefaultLimit: - description: Details of user managed limits + description: Details of user managed limits. properties: currentUsage: description: Amount that indicates the current usage of the limit. @@ -14879,6 +14956,9 @@ components: url: https://www.mongodb.com/docs/atlas/security/set-up-unified-aws-access/ pattern: ^([a-f0-9]{24})$ type: string + requirePrivateNetworking: + description: Indicates whether to do exports over PrivateLink as opposed to public IPs. Defaults to False. + type: boolean type: object required: - bucketName @@ -14927,6 +15007,9 @@ components: example: us-east-1 readOnly: true type: string + requirePrivateNetworking: + description: Indicates whether to use privatelink. User supplied. + type: boolean required: - _id - bucketName @@ -15925,7 +16008,7 @@ components: description: One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index. type: object x-xgen-IPA-exception: - xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation + xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation. type: array name: description: Name of index. @@ -16057,6 +16140,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -16098,6 +16183,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -16321,7 +16408,7 @@ components: - CRITICAL type: string EventTypeDetails: - description: A singular type of event + description: A singular type of event. properties: alertable: description: Whether or not this event type can be configured as an alert via the API. @@ -16442,6 +16529,7 @@ components: - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES + - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA title: Cluster Connection Audit Types type: string - enum: @@ -16578,6 +16666,10 @@ components: - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - ENCRYPTION_AT_REST_CONFIG_IS_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -16604,6 +16696,7 @@ components: - SSH_KEY_NDS_HOST_ACCESS_REFRESHED - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT - SSH_KEY_NDS_HOST_ACCESS_GRANTED + - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED - HOST_SSH_SESSION_ENDED - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS - PUSH_BASED_LOG_EXPORT_RESUMED @@ -16616,6 +16709,8 @@ components: - HOST_SECURITY_CHECKUP_NOT_MET title: Host Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - INSIDE_METRIC_THRESHOLD - OUTSIDE_METRIC_THRESHOLD @@ -16766,6 +16861,7 @@ components: - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED + - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED @@ -16825,6 +16921,18 @@ components: - PUSH_BASED_LOG_EXPORT_ENABLED - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED - PUSH_BASED_LOG_EXPORT_DISABLED + - LOG_STREAMING_ENABLED + - LOG_STREAMING_CONFIGURATION_UPDATED + - LOG_STREAMING_DISABLED + - DATADOG_LOG_STREAMING_ENABLED + - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED + - DATADOG_LOG_STREAMING_DISABLED + - SPLUNK_LOG_STREAMING_ENABLED + - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED + - SPLUNK_LOG_STREAMING_DISABLED + - S3_LOG_STREAMING_ENABLED + - S3_LOG_STREAMING_CONFIGURATION_UPDATED + - S3_LOG_STREAMING_DISABLED - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED - CONTAINER_DELETED - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED @@ -16861,8 +16969,12 @@ components: - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED + - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE + - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE title: NDS Audit Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - DB_CHECK_SUBMITTED - DB_CHECK_UPDATED @@ -17102,6 +17214,11 @@ components: - RESOURCE_POLICY_VIOLATED title: Atlas Resource Policy Audit Types type: string + - enum: + - QUERY_SHAPE_BLOCKED + - QUERY_SHAPE_UNBLOCKED + title: Query Shape Event Types + type: string type: object EventTypeForOrg: oneOf: @@ -17218,6 +17335,8 @@ components: - EVERGREEN_PRIORITY_MODIFIED title: Billing Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - FEDERATION_SETTINGS_CREATED - FEDERATION_SETTINGS_DELETED @@ -17245,6 +17364,8 @@ components: - ROLE_MAPPING_DELETED title: Federation Settings Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - GROUP_DELETED - GROUP_CREATED @@ -17336,6 +17457,8 @@ components: - SANDBOX_DISABLED_FOR_ORG title: Org Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - AWS_SELF_SERVE_ACCOUNT_LINKED - AWS_SELF_SERVE_ACCOUNT_LINK_PENDING @@ -17485,7 +17608,7 @@ components: - metricName type: object ExtraRetentionSetting: - description: extra retention setting item in the desired backup policy. + description: Extra retention setting item in the desired backup policy. properties: frequencyType: description: The frequency type for the extra retention settings for the cluster. @@ -19595,6 +19718,30 @@ components: required: - metricName type: object + GCPAccountDetails: + properties: + cidrBlock: + description: The VPC CIDR Block. + type: string + cloudProvider: + description: Cloud provider. + type: string + gcpProjectId: + description: The GCP Project ID. + type: string + 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. + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: '#/components/schemas/Link' + readOnly: true + type: array + vpcNetworkName: + description: The name of the VPC network. + type: string + type: object GCPCloudProviderContainer: allOf: - $ref: '#/components/schemas/CloudProviderContainer' @@ -19669,8 +19816,6 @@ components: - WESTERN_EUROPE - WESTERN_US type: string - x-xgen-IPA-exception: - xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation type: array type: object description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. @@ -21419,6 +21564,7 @@ components: - SSH_KEY_NDS_HOST_ACCESS_REFRESHED - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT - SSH_KEY_NDS_HOST_ACCESS_GRANTED + - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED - HOST_SSH_SESSION_ENDED - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS - PUSH_BASED_LOG_EXPORT_RESUMED @@ -24163,7 +24309,7 @@ components: title: Cluster Description type: object LegacyAtlasTenantClusterUpgradeRequest: - description: Request containing target state of tenant cluster to be upgraded + description: Request containing target state of tenant cluster to be upgraded. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -25973,7 +26119,7 @@ components: type: array type: object MetricDataPoint: - description: value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. + description: Value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. properties: timestamp: description: Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -25987,7 +26133,7 @@ components: readOnly: true type: object MetricDataPoint_Atlas: - description: value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. + description: Value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. properties: timestamp: description: Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -26521,6 +26667,7 @@ components: - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED + - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED @@ -26580,6 +26727,18 @@ components: - PUSH_BASED_LOG_EXPORT_ENABLED - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED - PUSH_BASED_LOG_EXPORT_DISABLED + - LOG_STREAMING_ENABLED + - LOG_STREAMING_CONFIGURATION_UPDATED + - LOG_STREAMING_DISABLED + - DATADOG_LOG_STREAMING_ENABLED + - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED + - DATADOG_LOG_STREAMING_DISABLED + - SPLUNK_LOG_STREAMING_ENABLED + - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED + - SPLUNK_LOG_STREAMING_DISABLED + - S3_LOG_STREAMING_ENABLED + - S3_LOG_STREAMING_CONFIGURATION_UPDATED + - S3_LOG_STREAMING_DISABLED - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED - CONTAINER_DELETED - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED @@ -26616,6 +26775,8 @@ components: - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED + - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE + - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE example: CLUSTER_CREATED title: NDS Audit Types type: string @@ -27380,7 +27541,10 @@ components: ***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. - To learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. + Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. + externalDocs: + description: New Relic Plugin EOL Statement + url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267 properties: accountId: description: Unique 40-hexadecimal digit string that identifies your New Relic account. @@ -28859,7 +29023,7 @@ components: readOnly: true type: object OrgServiceAccountRequest: - description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. + description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request. properties: description: description: Human readable description for the Service Account. @@ -29231,6 +29395,8 @@ components: apiAccessListRequired: description: Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization. type: boolean + customSessionTimeouts: + $ref: '#/components/schemas/CustomSessionTimeouts' genAIFeaturesEnabled: default: true description: Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and is enabled by default. Once this setting is turned on, Project Owners may be able to enable or disable individual AI features at the project level. @@ -31063,8 +31229,8 @@ components: readOnly: true type: object x-xgen-IPA-exception: - xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation. + xgen-IPA-124-array-max-items: Schema predates IPA validation. readOnly: true type: array stats: @@ -31256,7 +31422,7 @@ components: type: array type: object PinnedNamespaces: - description: Pinned namespaces view for cluster + description: Pinned namespaces view for cluster. properties: clusterId: description: Unique 24-hexadecimal digit string that identifies the request cluster. @@ -31762,6 +31928,9 @@ components: queryShapeHash: description: A hexadecimal string that represents the hash of a MongoDB query shape. type: string + systemQuery: + description: Indicates whether this query shape represents a system-initiated query. + type: boolean totalTimeToResponseMicros: description: Time in microseconds spent from the beginning of query processing to the first server response. format: double @@ -32602,7 +32771,7 @@ components: title: Replication Specifications type: object RequestAccepted: - description: Accepted + description: Accepted. type: object ResourceEventTypeView: description: Unique identifier of event type. @@ -36077,6 +36246,14 @@ components: StreamsKafkaAuthentication: description: User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode. properties: + clientId: + description: OIDC client identifier for authentication to the Kafka cluster. This field is not supported yet. + type: string + clientSecret: + description: OIDC client secret for authentication to the Kafka cluster. This field is not supported yet. + format: password + type: string + writeOnly: true 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. externalDocs: @@ -36087,13 +36264,22 @@ components: readOnly: true type: array mechanism: - description: Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512. + description: Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER. + type: string + method: + description: SASL OAUTHBEARER authentication method. Can only be OIDC currently. This field is not supported yet. type: string password: description: Password of the account to connect to the Kafka cluster. format: password type: string writeOnly: true + saslOauthbearerExtensions: + description: SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration. This field is not supported yet. + type: string + scope: + description: OIDC scope parameter defining the access permissions requested. This field is not supported yet. + type: string sslCertificate: description: SSL certificate for client authentication to Kafka. type: string @@ -36105,6 +36291,9 @@ components: description: Password for the SSL key, if it is password protected. type: string writeOnly: true + tokenEndpointUrl: + description: OIDC token endpoint URL for obtaining access tokens. This field is not supported yet. + type: string username: description: Username of the account to connect to the Kafka cluster. type: string @@ -36169,10 +36358,6 @@ components: name: description: Reserved. Will be used by PRIVATE_LINK connection type. type: string - tgwId: - description: Reserved. Will be used by TRANSIT_GATEWAY connection type. - pattern: ^(tgw-)[0-9a-zA-Z]+$ - type: string tgwRouteId: description: Reserved. Will be used by TRANSIT_GATEWAY connection type. example: 32b6e34b3d91647abb20e7b8 @@ -36187,9 +36372,6 @@ components: - TRANSIT_GATEWAY title: Networking Access Type type: string - vpcCIDR: - description: Reserved. Will be used by TRANSIT_GATEWAY connection type. - type: string type: object StreamsKafkaSecurity: description: Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. @@ -36245,7 +36427,7 @@ components: title: Streams Matcher Fields type: string StreamsModifyStreamProcessor: - description: A request to modify an existing stream processor + description: A request to modify an existing stream processor. 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. @@ -36336,6 +36518,13 @@ components: description: Error message if the state is FAILED. readOnly: true type: string + gcpServiceAttachmentUris: + description: Service Attachment URIs of each availability zone for the GCP Confluent cluster. + items: + type: string + maxItems: 3 + type: array + uniqueItems: true interfaceEndpointId: description: Interface endpoint ID that is created from the service endpoint ID provided. readOnly: true @@ -36508,7 +36697,7 @@ components: type: boolean type: object StreamsStartStreamProcessorWith: - description: A request to start a stream processor + description: A request to start a stream processor. 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. @@ -37405,7 +37594,7 @@ components: definition: $ref: '#/components/schemas/TextSearchIndexDefinition' type: object - description: Text Search Index Create Request + description: Text Search Index Create Request. required: - collectionName - database @@ -38907,7 +39096,7 @@ components: definition: $ref: '#/components/schemas/VectorSearchIndexDefinition' type: object - description: Vector Search Index Create Request + description: Vector Search Index Create Request. required: - collectionName - database @@ -39855,7 +40044,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 71ac9e4b796c59607af25b073aa510451ae85fdb + x-xgen-sha: 6d1feb3f4a77896c6eda8ce3e744affc6a1f024c openapi: 3.0.1 paths: /api/atlas/v2: @@ -39883,14 +40072,17 @@ paths: $ref: '#/components/responses/forbidden' "500": $ref: '#/components/responses/internalServerError' - summary: Return the status of this MongoDB application + summary: Return the Status of This MongoDB Application tags: - Root x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus + x-xgen-method-verb-override: + customMethod: false + verb: getSystemStatus /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. - operationId: listAlertConfigurationMatchersFieldNames + operationId: listAlertConfigMatcherFieldNames parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -39903,7 +40095,7 @@ paths: $ref: '#/components/schemas/MatcherFieldView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -39915,11 +40107,12 @@ paths: summary: Return All Alert Configuration Matchers Field Names tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigMatcherFieldNames + x-xgen-operation-id-override: listMatcherFieldNames /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. - operationId: listClustersForAllProjects + operationId: listClusterDetails parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -39943,7 +40136,10 @@ paths: summary: Return All Authorized Clusters in All Projects tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusterDetails + x-xgen-method-verb-override: + customMethod: false + verb: listDetails /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -39975,7 +40171,7 @@ paths: /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' - operationId: deleteFederationApp + operationId: deleteFederationSetting parameters: - $ref: '#/components/parameters/federationSettingsId' responses: @@ -39997,11 +40193,11 @@ paths: summary: Delete One Federation Settings Instance tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSetting /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. - operationId: listConnectedOrgConfigs + operationId: listFederationSettingConnectedOrgConfigs parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40028,11 +40224,12 @@ paths: summary: Return All Organization Configurations from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigs + x-xgen-operation-id-override: listConnectedOrgConfigs /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' - operationId: removeConnectedOrgConfig + operationId: removeFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40063,13 +40260,14 @@ paths: summary: Remove One Organization Configuration from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeFederationSettingConnectedOrgConfig x-xgen-method-verb-override: customMethod: "True" verb: remove + x-xgen-operation-id-override: removeConnectedOrgConfig get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. - operationId: getConnectedOrgConfig + operationId: getFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40088,7 +40286,7 @@ paths: schema: $ref: '#/components/schemas/ConnectedOrgConfig' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40104,10 +40302,11 @@ paths: summary: Return One Organization Configuration from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfig + x-xgen-operation-id-override: getConnectedOrgConfig patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected." - operationId: updateConnectedOrgConfig + operationId: updateFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40147,11 +40346,12 @@ paths: summary: Update One Organization Configuration in One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfig + x-xgen-operation-id-override: updateConnectedOrgConfig /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: listRoleMappings + operationId: listFederationSettingConnectedOrgConfigRoleMappings parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40177,10 +40377,11 @@ paths: summary: Return All Role Mappings from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigRoleMappings + x-xgen-operation-id-override: listRoleMappings post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: createRoleMapping + operationId: createFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40213,11 +40414,12 @@ paths: summary: Create One Role Mapping in One Organization Configuration tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: createRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: deleteRoleMapping + operationId: deleteFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. @@ -40249,10 +40451,11 @@ paths: summary: Remove One Role Mapping from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: deleteRoleMapping get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: getRoleMapping + operationId: getFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. @@ -40272,7 +40475,7 @@ paths: schema: $ref: '#/components/schemas/AuthFederationRoleMapping' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40288,10 +40491,11 @@ paths: summary: Return One Role Mapping from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: getRoleMapping put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateRoleMapping + operationId: updateFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. @@ -40332,11 +40536,12 @@ paths: summary: Update One Role Mapping in One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: updateRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: listIdentityProviders + operationId: listFederationSettingIdentityProviders parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40371,7 +40576,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedFederationIdentityProvider' x-xgen-IPA-exception: - xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation + xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40387,13 +40592,14 @@ paths: summary: Return All Identity Providers in One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingIdentityProviders + x-xgen-operation-id-override: listIdentityProviders post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. **Note**: This resource only supports the creation of OIDC identity providers. - operationId: createIdentityProvider + operationId: createFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40425,14 +40631,15 @@ paths: summary: Create One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingIdentityProvider + x-xgen-operation-id-override: createIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider." externalDocs: description: Manage Organization Mapping for Federated Authentication url: https://www.mongodb.com/docs/atlas/security/manage-org-mapping/ - operationId: deleteIdentityProvider + operationId: deleteFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the identity provider to connect. @@ -40462,10 +40669,11 @@ paths: summary: Delete One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingIdentityProvider + x-xgen-operation-id-override: deleteIdentityProvider get: description: Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: getIdentityProvider + operationId: getFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. @@ -40484,13 +40692,13 @@ paths: $ref: '#/components/schemas/FederationSamlIdentityProvider' x-sunset: "2025-01-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-11-15+json: schema: $ref: '#/components/schemas/FederationIdentityProvider' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-11-15" description: OK "400": @@ -40506,13 +40714,14 @@ paths: summary: Return One Identity Provider by ID tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProvider + x-xgen-operation-id-override: getIdentityProvider patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. **Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. - operationId: updateIdentityProvider + operationId: updateFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. @@ -40559,14 +40768,15 @@ paths: summary: Update One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingIdentityProvider + x-xgen-operation-id-override: updateIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected." externalDocs: description: Configure OIDC Authorization url: https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks - operationId: revokeJwksFromIdentityProvider + operationId: revokeFederationSettingIdentityProviderJwks parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the identity provider to connect. @@ -40596,14 +40806,15 @@ paths: summary: Revoke JWKS from One OIDC Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeFederationSettingIdentityProviderJwks x-xgen-method-verb-override: customMethod: "True" verb: revoke + x-xgen-operation-id-override: revokeIdentityProviderJwks /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: getIdentityProviderMetadata + operationId: getFederationSettingIdentityProviderMetadata parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/identityProviderId' @@ -40628,14 +40839,15 @@ paths: summary: Return Metadata of One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProviderMetadata x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getIdentityProviderMetadata /api/atlas/v2/groups: get: description: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. - operationId: listProjects + operationId: listGroups parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -40663,7 +40875,7 @@ paths: summary: Return All Projects tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroups requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -40674,7 +40886,7 @@ paths: description: Get a list of all projects inside of the organisation post: description: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. - operationId: createProject + operationId: createGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -40724,11 +40936,11 @@ paths: summary: Create One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroup /api/atlas/v2/groups/{groupId}: delete: description: Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProject + operationId: deleteGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40754,7 +40966,7 @@ paths: summary: Remove One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroup requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -40765,7 +40977,7 @@ paths: description: Deletes an existing project get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProject + operationId: getGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40777,8 +40989,7 @@ paths: schema: $ref: '#/components/schemas/Group' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40794,7 +41005,7 @@ paths: summary: Return One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroup requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -40805,7 +41016,7 @@ paths: description: Get a project using a project id patch: description: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProject + operationId: updateGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40847,12 +41058,12 @@ paths: summary: Update One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroup /api/atlas/v2/groups/{groupId}/access: post: deprecated: true description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - operationId: addUserToProject + operationId: addGroupAccessUser parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' @@ -40889,17 +41100,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addGroupAccessUser x-xgen-method-verb-override: customMethod: "True" verb: addUser + x-xgen-operation-id-override: addGroupUser /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: listProjectIpAccessLists + operationId: listGroupAccessListEntries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40931,7 +41143,11 @@ paths: - Project IP Access List x-xgen-changelog: "2025-05-08": Corrects an issue where the endpoint would include Atlas internal entries. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listGroupAccessListEntries + x-xgen-method-verb-override: + customMethod: false + verb: listEntries + x-xgen-operation-id-override: listAccessListEntries requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -40945,7 +41161,7 @@ paths: externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: createProjectIpAccessList + operationId: createGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40995,14 +41211,18 @@ paths: summary: Add Entries to Project IP Access List tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: createEntry + x-xgen-operation-id-override: createAccessListEntry /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: deleteProjectIpAccessList + operationId: deleteGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41043,7 +41263,11 @@ paths: summary: Remove One Entry from One Project IP Access List tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: deleteEntry + x-xgen-operation-id-override: deleteAccessListEntry requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -41057,7 +41281,7 @@ paths: externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: getProjectIpList + operationId: getGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41083,7 +41307,7 @@ paths: schema: $ref: '#/components/schemas/NetworkPermissionEntry' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41097,7 +41321,11 @@ paths: summary: Return One Project IP Access List Entry tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: getEntry + x-xgen-operation-id-override: getAccessListEntry requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -41109,7 +41337,7 @@ paths: /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. - operationId: getProjectIpAccessListStatus + operationId: getGroupAccessListStatus parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41135,7 +41363,7 @@ paths: schema: $ref: '#/components/schemas/NetworkPermissionEntryStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -41151,7 +41379,8 @@ paths: summary: Return Status of One Project IP Access List Entry tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListStatus + x-xgen-operation-id-override: getAccessListStatus requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -41166,7 +41395,7 @@ paths: Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listAlertConfigurations + operationId: listGroupAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41193,13 +41422,14 @@ paths: summary: Return All Alert Configurations in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listGroupAlertConfigs + x-xgen-operation-id-override: listAlertConfigs post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. - operationId: createAlertConfiguration + operationId: createGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41232,7 +41462,8 @@ paths: summary: Create One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createGroupAlertConfig + x-xgen-operation-id-override: createAlertConfig /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -41242,7 +41473,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: deleteAlertConfiguration + operationId: deleteGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41272,7 +41503,8 @@ paths: summary: Remove One Alert Configuration from One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteGroupAlertConfig + x-xgen-operation-id-override: deleteAlertConfig get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. @@ -41281,7 +41513,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: getAlertConfiguration + operationId: getGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41301,7 +41533,7 @@ paths: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41315,7 +41547,8 @@ paths: summary: Return One Alert Configuration from One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertConfig + x-xgen-operation-id-override: getAlertConfig patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41326,7 +41559,7 @@ paths: externalDocs: description: Update One Alert Configuration url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration - operationId: toggleAlertConfiguration + operationId: toggleGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41365,10 +41598,11 @@ paths: summary: Toggle State of One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleGroupAlertConfig x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: toggle + x-xgen-operation-id-override: toggleAlertConfig put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41379,7 +41613,7 @@ paths: externalDocs: description: Toggle One State of One Alert Configuration in One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration - operationId: updateAlertConfiguration + operationId: updateGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41420,7 +41654,8 @@ paths: summary: Update One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateGroupAlertConfig + x-xgen-operation-id-override: updateAlertConfig /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -41430,7 +41665,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: listAlertsByAlertConfigurationId + operationId: getGroupAlertConfigAlerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41453,8 +41688,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAlertView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41468,14 +41703,15 @@ paths: summary: Return All Open Alerts for One Alert Configuration tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlertConfigAlerts + x-xgen-operation-id-override: getAlertConfigAlerts /api/atlas/v2/groups/{groupId}/alerts: get: description: |- Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listAlerts + operationId: listGroupAlerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41513,7 +41749,8 @@ paths: summary: Return All Alerts from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listGroupAlerts + x-xgen-operation-id-override: listAlerts /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -41523,7 +41760,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: getAlert + operationId: getGroupAlert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41542,7 +41779,7 @@ paths: schema: $ref: '#/components/schemas/AlertViewForNdsGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41556,7 +41793,8 @@ paths: summary: Return One Alert from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlert + x-xgen-operation-id-override: getAlert patch: description: |- Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. @@ -41565,7 +41803,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: acknowledgeAlert + operationId: acknowledgeGroupAlert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41613,10 +41851,11 @@ paths: summary: Acknowledge One Alert from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeGroupAlert x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: acknowledge + x-xgen-operation-id-override: acknowledgeAlert /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -41626,7 +41865,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: listAlertConfigurationsByAlertId + operationId: getGroupAlertAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41648,8 +41887,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAlertConfigView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41663,14 +41902,15 @@ paths: summary: Return All Alert Configurations Set for One Alert tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertAlertConfigs + x-xgen-operation-id-override: getAlertConfigs /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: listProjectApiKeys + operationId: listGroupApiKeys parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41697,10 +41937,10 @@ paths: summary: Return All Organization API Keys Assigned to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listGroupApiKeys post: description: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createProjectApiKey + operationId: createGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41731,14 +41971,14 @@ paths: summary: Create and Assign One Organization API Key to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createGroupApiKey /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: removeProjectApiKey + operationId: removeGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41769,13 +42009,13 @@ paths: summary: Unassign One Organization API Key from One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeGroupApiKey x-xgen-method-verb-override: customMethod: "True" verb: remove patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. - operationId: updateApiKeyRoles + operationId: updateGroupApiKeyRoles parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pageNum' @@ -41818,13 +42058,14 @@ paths: summary: Update Organization API Key Roles for One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateGroupApiKeyRoles x-xgen-method-verb-override: customMethod: "True" verb: updateRoles + x-xgen-operation-id-override: updateApiKeyRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: addProjectApiKey + operationId: addGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41862,14 +42103,14 @@ paths: summary: Assign One Organization API Key to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addGroupApiKey x-xgen-method-verb-override: customMethod: "True" verb: add /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. - operationId: getAuditingConfiguration + operationId: getGroupAuditLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41881,7 +42122,7 @@ paths: schema: $ref: '#/components/schemas/AuditLog' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41895,10 +42136,10 @@ paths: summary: Return Auditing Configuration for One Project tags: - Auditing - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getGroupAuditLog patch: description: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. - operationId: updateAuditingConfiguration + operationId: updateGroupAuditLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41931,11 +42172,12 @@ paths: summary: Update Auditing Configuration for One Project tags: - Auditing - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateGroupAuditLog + x-xgen-operation-id-override: updateAuditLog /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getAwsCustomDns + operationId: getGroupAwsCustomDns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41947,7 +42189,7 @@ paths: schema: $ref: '#/components/schemas/AWSCustomDNSEnabledView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41961,10 +42203,11 @@ paths: summary: Return One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getGroupAwsCustomDns + x-xgen-operation-id-override: getAwsCustomDns patch: description: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: toggleAwsCustomDns + operationId: toggleGroupAwsCustomDns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41995,14 +42238,15 @@ paths: summary: Update State of One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleGroupAwsCustomDns x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleAwsCustomDns /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listExportBuckets + operationId: listGroupBackupExportBuckets parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42034,10 +42278,11 @@ paths: summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupExportBuckets + x-xgen-operation-id-override: listExportBuckets post: description: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createExportBucket + operationId: createGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42052,6 +42297,7 @@ paths: bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 + requirePrivateNetworking: false schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketRequest' x-xgen-version: "2023-01-01" @@ -42063,6 +42309,7 @@ paths: bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 + requirePrivateNetworking: false Azure: description: Azure value: @@ -42097,6 +42344,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42114,6 +42362,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true Azure: description: Azure value: @@ -42153,11 +42402,12 @@ paths: summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupExportBucket + x-xgen-operation-id-override: createExportBucket /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteExportBucket + operationId: deleteGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42188,10 +42438,11 @@ paths: summary: Delete One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupExportBucket + x-xgen-operation-id-override: deleteExportBucket get: description: Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getExportBucket + operationId: getGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42219,6 +42470,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42236,6 +42488,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true Azure: description: Azure value: @@ -42273,11 +42526,12 @@ paths: summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupExportBucket + x-xgen-operation-id-override: getExportBucket /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: delete: description: Disables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: disableDataProtectionSettings + operationId: disableGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42301,15 +42555,16 @@ paths: summary: Disable Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableGroupBackupCompliancePolicy x-xgen-method-verb-override: customMethod: "True" verb: disable + x-xgen-operation-id-override: disableCompliancePolicy x-xgen-atlascli: watcher: get: version: "2023-10-01" - operation-id: getDataProtectionSettings + operation-id: updateGroupBackupCompliancePolicy params: groupId: input:groupId expect: @@ -42319,7 +42574,7 @@ paths: - ACTIVE get: description: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getDataProtectionSettings + operationId: getGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42332,13 +42587,13 @@ paths: $ref: '#/components/schemas/DataProtectionSettings' x-sunset: "2026-10-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-10-01+json: schema: $ref: '#/components/schemas/DataProtectionSettings20231001' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-10-01" description: OK "401": @@ -42352,10 +42607,11 @@ paths: summary: Return Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupCompliancePolicy + x-xgen-operation-id-override: getCompliancePolicy put: description: Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateDataProtectionSettings + operationId: updateGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42404,12 +42660,13 @@ paths: summary: Update Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupCompliancePolicy + x-xgen-operation-id-override: updateCompliancePolicy x-xgen-atlascli: watcher: get: version: "2023-10-01" - operation-id: getDataProtectionSettings + operation-id: updateGroupBackupCompliancePolicy params: groupId: input:groupId expect: @@ -42420,7 +42677,7 @@ paths: /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listCloudProviderAccessRoles + operationId: listGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42432,9 +42689,9 @@ paths: schema: $ref: '#/components/schemas/CloudProviderAccessRoles' x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -42448,13 +42705,14 @@ paths: summary: Return All Cloud Provider Access Roles tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listGroupCloudProviderAccess + x-xgen-operation-id-override: listCloudProviderAccess post: description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status `IN_PROGRESS` will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ - operationId: createCloudProviderAccessRole + operationId: createGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42485,11 +42743,12 @@ paths: summary: Create One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createGroupCloudProviderAccess + x-xgen-operation-id-override: createCloudProviderAccess /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deauthorizeCloudProviderAccessRole + operationId: deauthorizeGroupCloudProviderAccessRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42530,14 +42789,15 @@ paths: summary: Deauthorize One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeGroupCloudProviderAccessRole x-xgen-method-verb-override: customMethod: "True" verb: deauthorizeRole + x-xgen-operation-id-override: deauthorizeProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getCloudProviderAccessRole + operationId: getGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42556,7 +42816,7 @@ paths: schema: $ref: '#/components/schemas/CloudProviderAccessRole' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -42570,13 +42830,14 @@ paths: summary: Return One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getGroupCloudProviderAccess + x-xgen-operation-id-override: getCloudProviderAccess patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ - operationId: authorizeCloudProviderAccessRole + operationId: authorizeGroupCloudProviderAccessRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42618,10 +42879,11 @@ paths: summary: Authorize One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeGroupCloudProviderAccessRole x-xgen-method-verb-override: customMethod: "True" verb: authorizeRole + x-xgen-operation-id-override: authorizeProviderAccessRole /api/atlas/v2/groups/{groupId}/clusters: get: description: |- @@ -42631,7 +42893,7 @@ paths: externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters - operationId: listClusters + operationId: listGroupClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42677,7 +42939,8 @@ paths: summary: Return All Clusters in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusters + x-xgen-operation-id-override: listClusters requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -42694,7 +42957,7 @@ paths: externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster - operationId: createCluster + operationId: createGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42927,14 +43190,14 @@ paths: - Clusters x-xgen-changelog: "2025-06-05": Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createGroupCluster + x-xgen-operation-id-override: createCluster x-xgen-atlascli: watcher: get: version: "2024-08-05" - operation-id: getCluster + operation-id: createGroupCluster params: - clusterName: body:$.name groupId: body:$.groupId expect: match: @@ -42950,7 +43213,7 @@ paths: externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster - operationId: deleteCluster + operationId: deleteGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -42997,7 +43260,8 @@ paths: summary: Remove One Cluster from One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteGroupCluster + x-xgen-operation-id-override: deleteCluster requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -43009,8 +43273,8 @@ paths: x-xgen-atlascli: watcher: get: - version: "2024-08-05" - operation-id: getCluster + version: "2023-01-01" + operation-id: deleteGroupCluster params: clusterName: input:clusterName groupId: input:groupId @@ -43024,7 +43288,7 @@ paths: externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster - operationId: getCluster + operationId: getGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43050,20 +43314,20 @@ paths: $ref: '#/components/schemas/LegacyAtlasCluster' x-sunset: "2026-11-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-02-01+json: schema: $ref: '#/components/schemas/AdvancedClusterDescription' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -43079,7 +43343,8 @@ paths: summary: Return One Cluster from One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupCluster + x-xgen-operation-id-override: getCluster requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -43090,7 +43355,7 @@ paths: description: Returns the details for the specified cluster in the project patch: description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster''s termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can''t modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters.' - operationId: updateCluster + operationId: updateGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43180,12 +43445,13 @@ paths: - Clusters x-xgen-changelog: "2025-06-05": Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupCluster + x-xgen-operation-id-override: updateCluster x-xgen-atlascli: watcher: get: version: "2024-08-05" - operation-id: getCluster + operation-id: updateGroupCluster params: clusterName: input:clusterName groupId: input:groupId @@ -43197,7 +43463,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. - operationId: getCollStatsLatencyNamespaceClusterMeasurements + operationId: listGroupClusterCollStatMeasurements parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster to retrieve metrics for. @@ -43280,11 +43546,12 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatMeasurements + x-xgen-operation-id-override: listCollStatMeasurements /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. - operationId: getCollStatsLatencyNamespacesForCluster + operationId: getGroupClusterCollStatNamespaces parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster to pin namespaces to. @@ -43324,18 +43591,19 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Ranked Namespaces from a Cluster + summary: Return Ranked Namespaces from One Cluster tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupClusterCollStatNamespaces x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getClusterNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: deprecated: true description: Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. - operationId: autoScalingConfiguration + operationId: autoGroupClusterScalingConfiguration parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43354,7 +43622,7 @@ paths: schema: $ref: '#/components/schemas/ClusterDescriptionAutoScalingModeConfiguration' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -43370,13 +43638,14 @@ paths: summary: Return Auto Scaling Configuration for One Sharded Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoGroupClusterScalingConfiguration x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: autoScalingConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: listBackupExportJobs + operationId: listGroupClusterBackupExports parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43410,10 +43679,11 @@ paths: summary: Return All Snapshot Export Jobs tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupExports + x-xgen-operation-id-override: listBackupExports post: description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: createBackupExportJob + operationId: createGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43454,16 +43724,16 @@ paths: summary: Create One Snapshot Export Job tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupExport + x-xgen-operation-id-override: createBackupExport x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getBackupExportJob + operation-id: createGroupClusterBackupExport params: groupId: input:groupId clusterName: input:clusterName - exportId: body:$.id expect: match: path: $.state @@ -43474,7 +43744,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: getBackupExportJob + operationId: getGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43512,11 +43782,12 @@ paths: summary: Return One Snapshot Export Job tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupExport + x-xgen-operation-id-override: getBackupExport /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: listBackupRestoreJobs + operationId: listGroupClusterBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43550,13 +43821,14 @@ paths: summary: Return All Restore Jobs for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupRestoreJobs + x-xgen-operation-id-override: listBackupRestoreJobs post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: createBackupRestoreJob + operationId: createGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43595,14 +43867,15 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Cluster + summary: Create One Restore Job of One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupRestoreJob + x-xgen-operation-id-override: createBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: cancelBackupRestoreJob + operationId: cancelGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43642,13 +43915,14 @@ paths: summary: Cancel One Restore Job for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelGroupClusterBackupRestoreJob x-xgen-method-verb-override: customMethod: "True" verb: cancel + x-xgen-operation-id-override: cancelBackupRestoreJob get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: getBackupRestoreJob + operationId: getGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43686,11 +43960,12 @@ paths: summary: Return One Restore Job for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupRestoreJob + x-xgen-operation-id-override: getBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: description: Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: deleteAllBackupSchedules + operationId: deleteGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43727,10 +44002,11 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSchedule + x-xgen-operation-id-override: deleteClusterBackupSchedule get: description: Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getBackupSchedule + operationId: getGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43766,13 +44042,14 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSchedule x-xgen-method-verb-override: customMethod: "False" verb: get + x-xgen-operation-id-override: getBackupSchedule patch: description: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateBackupSchedule + operationId: updateGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43823,11 +44100,12 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSchedule + x-xgen-operation-id-override: updateBackupSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: listReplicaSetBackups + operationId: listGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43863,13 +44141,14 @@ paths: summary: Return All Replica Set Cloud Backups tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshots + x-xgen-operation-id-override: listBackupSnapshots post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: takeSnapshot + operationId: takeGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43909,19 +44188,19 @@ paths: summary: Take One On-Demand Snapshot tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeGroupClusterBackupSnapshots x-xgen-method-verb-override: customMethod: "True" verb: take + x-xgen-operation-id-override: takeSnapshots x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: takeGroupClusterBackupSnapshots params: groupId: input:groupId clusterName: input:clusterName - snapshotId: body:$.id expect: match: path: $.status @@ -43931,7 +44210,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteReplicaSetBackup + operationId: deleteGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43969,12 +44248,13 @@ paths: summary: Remove One Replica Set Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshot + x-xgen-operation-id-override: deleteClusterBackupSnapshot x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: deleteGroupClusterBackupSnapshot params: groupId: input:groupId clusterName: input:clusterName @@ -43983,7 +44263,7 @@ paths: http-code: 404 get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: getReplicaSetBackup + operationId: getGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44009,7 +44289,7 @@ paths: schema: $ref: '#/components/schemas/DiskBackupReplicaSet' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -44025,10 +44305,11 @@ paths: summary: Return One Replica Set Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshot + x-xgen-operation-id-override: getClusterBackupSnapshot patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: updateSnapshotRetention + operationId: updateGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44075,7 +44356,8 @@ paths: summary: Update Expiration Date for One Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSnapshot + x-xgen-operation-id-override: updateBackupSnapshot x-xgen-atlascli: override: description: | @@ -44083,7 +44365,7 @@ paths: watcher: get: version: "2023-01-01" - operation-id: getReplicaSetBackup + operation-id: updateGroupClusterBackupSnapshot params: groupId: input:groupId clusterName: input:clusterName @@ -44097,7 +44379,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteShardedClusterBackup + operationId: deleteGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44133,10 +44415,11 @@ paths: summary: Remove One Sharded Cluster Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshotShardedCluster + x-xgen-operation-id-override: deleteBackupShardedCluster get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: getShardedClusterBackup + operationId: getGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44162,7 +44445,7 @@ paths: schema: $ref: '#/components/schemas/DiskBackupShardedClusterSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -44178,11 +44461,12 @@ paths: summary: Return One Sharded Cluster Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshotShardedCluster + x-xgen-operation-id-override: getBackupShardedCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: listShardedClusterBackups + operationId: listGroupClusterBackupSnapshotShardedClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44215,7 +44499,8 @@ paths: summary: Return All Sharded Cluster Cloud Backups tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshotShardedClusters + x-xgen-operation-id-override: listBackupShardedClusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: deprecated: true @@ -44226,7 +44511,7 @@ paths: externalDocs: description: downloadFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup - operationId: downloadSharedClusterBackup + operationId: downloadGroupClusterBackupTenant parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44269,9 +44554,10 @@ paths: summary: Download One M2 or M5 Cluster Snapshot tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadGroupClusterBackupTenant x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: downloadClusterBackupTenant /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: deprecated: true @@ -44282,7 +44568,7 @@ paths: externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob - operationId: createSharedClusterBackupRestoreJob + operationId: createGroupClusterBackupTenantRestore parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44325,7 +44611,8 @@ paths: summary: Create One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createGroupClusterBackupTenantRestore + x-xgen-operation-id-override: createBackupTenantRestore /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: deprecated: true @@ -44336,7 +44623,7 @@ paths: externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs - operationId: listSharedClusterBackupRestoreJobs + operationId: listGroupClusterBackupTenantRestores parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44370,7 +44657,8 @@ paths: summary: Return All Restore Jobs for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listGroupClusterBackupTenantRestores + x-xgen-operation-id-override: listBackupTenantRestores /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: deprecated: true @@ -44381,7 +44669,7 @@ paths: externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob - operationId: getSharedClusterBackupRestoreJob + operationId: getGroupClusterBackupTenantRestore parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44422,7 +44710,8 @@ paths: summary: Return One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getGroupClusterBackupTenantRestore + x-xgen-operation-id-override: getBackupTenantRestore /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: deprecated: true @@ -44433,7 +44722,7 @@ paths: externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups - operationId: listSharedClusterBackups + operationId: listGroupClusterBackupTenantSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44467,7 +44756,8 @@ paths: summary: Return All Snapshots for One M2 or M5 Cluster tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listGroupClusterBackupTenantSnapshots + x-xgen-operation-id-override: listClusterBackupSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: deprecated: true @@ -44478,7 +44768,7 @@ paths: externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup - operationId: getSharedClusterBackup + operationId: getGroupClusterBackupTenantSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44519,12 +44809,13 @@ paths: summary: Return One Snapshot of One M2 or M5 Cluster tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getGroupClusterBackupTenantSnapshot + x-xgen-operation-id-override: getBackupTenantSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true description: Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listLegacyBackupCheckpoints + operationId: listGroupClusterBackupCheckpoints parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44558,12 +44849,13 @@ paths: summary: Return All Legacy Backup Checkpoints tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterBackupCheckpoints + x-xgen-operation-id-override: listClusterBackupCheckpoints /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true description: Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getLegacyBackupCheckpoint + operationId: getGroupClusterBackupCheckpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44589,7 +44881,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasCheckpointView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -44605,11 +44897,12 @@ paths: summary: Return One Legacy Backup Checkpoint tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterBackupCheckpoint + x-xgen-operation-id-override: getClusterBackupCheckpoint /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. - operationId: getPinnedNamespaces + operationId: listGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44641,13 +44934,14 @@ paths: summary: Return Pinned Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: listNamespaces + x-xgen-operation-id-override: listPinnedNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. - operationId: pinNamespacesPatch + operationId: updateGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44693,17 +44987,18 @@ paths: summary: Add Pinned Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/updateGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: customMethod: "True" verb: updateNamespaces + x-xgen-operation-id-override: updatePinnedNamespaces x-xgen-atlascli: override: description: | Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. put: description: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. - operationId: pinNamespacesPut + operationId: pinGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44749,14 +45044,15 @@ paths: summary: Pin Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: customMethod: "True" verb: pinNamespaces + x-xgen-operation-id-override: pinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - operationId: unpinNamespaces + operationId: unpinGroupClusterCollStatUnpinNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44792,13 +45088,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Unpin namespaces + summary: Unpin Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinGroupClusterCollStatUnpinNamespaces x-xgen-method-verb-override: customMethod: "True" verb: unpinNamespaces + x-xgen-operation-id-override: unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -44806,7 +45103,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: createAtlasSearchIndexDeprecated + operationId: createGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44849,7 +45146,8 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterFtsIndex + x-xgen-operation-id-override: createClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: deprecated: true @@ -44857,7 +45155,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexesDeprecated + operationId: listGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44890,7 +45188,7 @@ paths: $ref: '#/components/schemas/ClusterSearchIndex' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-11-30" x-xgen-version: "2023-01-01" description: OK @@ -44905,7 +45203,11 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterFtsIndex + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: deprecated: true @@ -44913,7 +45215,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndexDeprecated + operationId: deleteGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44954,14 +45256,15 @@ paths: summary: Remove One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterFtsIndex + x-xgen-operation-id-override: deleteClusterFtsIndex get: deprecated: true description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndexDeprecated + operationId: getGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45002,14 +45305,15 @@ paths: summary: Return One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterFtsIndex + x-xgen-operation-id-override: getClusterFtsIndex patch: deprecated: true description: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndexDeprecated + operationId: updateGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45061,14 +45365,15 @@ paths: summary: Update One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterFtsIndex + x-xgen-operation-id-override: updateClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: description: Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: getManagedNamespace + operationId: getGroupClusterGlobalWrites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45088,20 +45393,20 @@ paths: $ref: '#/components/schemas/GeoSharding' x-sunset: "2026-11-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-02-01+json: schema: $ref: '#/components/schemas/GeoSharding' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/GeoSharding20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -45115,14 +45420,15 @@ paths: summary: Return One Managed Namespace in One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getGroupClusterGlobalWrites + x-xgen-operation-id-override: getClusterGlobalWrites /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: description: Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: deleteAllCustomZoneMappings + operationId: deleteGroupClusterGlobalWriteCustomZoneMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45163,13 +45469,14 @@ paths: summary: Remove All Custom Zone Mappings from One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteCustomZoneMapping + x-xgen-operation-id-override: deleteCustomZoneMapping post: description: Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: createCustomZoneMapping + operationId: createGroupClusterGlobalWriteCustomZoneMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45226,14 +45533,15 @@ paths: summary: Add One Custom Zone Mapping to One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteCustomZoneMapping + x-xgen-operation-id-override: createCustomZoneMapping /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: description: Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: deleteManagedNamespace + operationId: deleteGroupClusterGlobalWriteManagedNamespaces parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45286,13 +45594,14 @@ paths: summary: Remove One Managed Namespace from One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteManagedNamespaces + x-xgen-operation-id-override: deleteManagedNamespaces post: description: Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: createManagedNamespace + operationId: createGroupClusterGlobalWriteManagedNamespace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45351,14 +45660,15 @@ paths: summary: Create One Managed Namespace in One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteManagedNamespace + x-xgen-operation-id-override: createManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: description: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Rolling Index Builds on Replica Sets url: https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/ - operationId: createRollingIndex + operationId: createGroupClusterIndexRollingIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45463,14 +45773,18 @@ paths: summary: Create One Rolling Index tags: - Rolling Index - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createGroupClusterIndexRollingIndex + x-xgen-method-verb-override: + customMethod: false + verb: createRollingIndex + x-xgen-operation-id-override: createRollingIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: listOnlineArchives + operationId: listGroupClusterOnlineArchives parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45504,13 +45818,14 @@ paths: summary: Return All Online Archives for One Cluster tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listGroupClusterOnlineArchives + x-xgen-operation-id-override: listOnlineArchives post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: createOnlineArchive + operationId: createGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45554,16 +45869,16 @@ paths: - Online Archive x-xgen-changelog: "2023-08-02": If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createGroupClusterOnlineArchive + x-xgen-operation-id-override: createOnlineArchive x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: createGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName - archiveId: body:$.id expect: match: path: $.state @@ -45579,7 +45894,7 @@ paths: externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: deleteOnlineArchive + operationId: deleteGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -45615,12 +45930,13 @@ paths: summary: Remove One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteGroupClusterOnlineArchive + x-xgen-operation-id-override: deleteOnlineArchive x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: deleteGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName @@ -45632,7 +45948,7 @@ paths: externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: getOnlineArchive + operationId: getGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45658,7 +45974,7 @@ paths: schema: $ref: '#/components/schemas/BackupOnlineArchive' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -45674,13 +45990,14 @@ paths: summary: Return One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getGroupClusterOnlineArchive + x-xgen-operation-id-override: getOnlineArchive patch: description: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: updateOnlineArchive + operationId: updateGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45729,12 +46046,13 @@ paths: summary: Update One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateGroupClusterOnlineArchive + x-xgen-operation-id-override: updateOnlineArchive x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getOnlineArchive + operation-id: updateGroupClusterOnlineArchive params: groupId: input:groupId clusterName: input:clusterName @@ -45754,7 +46072,7 @@ paths: externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: downloadOnlineArchiveQueryLogs + operationId: downloadGroupClusterOnlineArchiveQueryLogs parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -45814,17 +46132,18 @@ paths: summary: Download Online Archive Query Logs tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadGroupClusterOnlineArchiveQueryLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadQueryLogs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: endOutageSimulation + operationId: endGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45857,15 +46176,16 @@ paths: summary: End One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endGroupClusterOutageSimulation x-xgen-method-verb-override: customMethod: "True" verb: end + x-xgen-operation-id-override: endOutageSimulation x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getOutageSimulation + operation-id: endGroupClusterOutageSimulation params: groupId: input:groupId clusterName: input:clusterName @@ -45876,7 +46196,7 @@ paths: externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: getOutageSimulation + operationId: getGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45913,16 +46233,17 @@ paths: summary: Return One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getGroupClusterOutageSimulation x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getOutageSimulation post: description: Starts a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: startOutageSimulation + operationId: startGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45962,15 +46283,16 @@ paths: summary: Start One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startGroupClusterOutageSimulation x-xgen-method-verb-override: customMethod: "True" verb: start + x-xgen-operation-id-override: startOutageSimulation x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getOutageSimulation + operation-id: startGroupClusterOutageSimulation params: groupId: input:groupId clusterName: input:clusterName @@ -45982,7 +46304,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions: get: description: Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDropIndexes + operationId: listGroupClusterPerformanceAdvisorDropIndexSuggestions parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -46015,11 +46337,12 @@ paths: summary: Return All Suggested Indexes to Drop tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorDropIndexSuggestions + x-xgen-operation-id-override: listDropIndexSuggestions /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice: get: description: Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSchemaAdvice + operationId: listGroupClusterPerformanceAdvisorSchemaAdvice parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -46052,11 +46375,12 @@ paths: summary: Return Schema Advice tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSchemaAdvice + x-xgen-operation-id-override: listSchemaAdvice /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listClusterSuggestedIndexes + operationId: listGroupClusterPerformanceAdvisorSuggestedIndexes parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -46132,14 +46456,15 @@ paths: summary: Return All Suggested Indexes tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSuggestedIndexes + x-xgen-operation-id-override: listClusterSuggestedIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: getClusterAdvancedConfiguration + operationId: getGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46159,13 +46484,13 @@ paths: $ref: '#/components/schemas/ClusterDescriptionProcessArgs' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionProcessArgs20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -46181,13 +46506,14 @@ paths: summary: Return Advanced Configuration Options for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterProcessArgs + x-xgen-operation-id-override: getProcessArgs patch: description: Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: updateClusterAdvancedConfiguration + operationId: updateGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46237,7 +46563,8 @@ paths: summary: Update Advanced Configuration Options for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupClusterProcessArgs + x-xgen-operation-id-override: updateProcessArgs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details: get: description: Returns the metadata and statistics summary for a given query shape hash. @@ -46320,10 +46647,11 @@ paths: tags: - Query Shape Insights x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightDetails + x-xgen-operation-id-override: getQueryShapeDetails /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 + operationId: listGroupClusterQueryShapeInsightSummaries parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -46463,11 +46791,12 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/listGroupClusterQueryShapeInsightSummaries + x-xgen-operation-id-override: listQueryShapeSummaries /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. - operationId: testFailover + operationId: restartGroupClusterPrimaries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46499,9 +46828,10 @@ paths: summary: Test Failover for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/restartGroupClusterPrimaries x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: restartPrimaries /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -46512,7 +46842,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: listLegacyBackupRestoreJobs + operationId: listGroupClusterRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46554,14 +46884,15 @@ paths: summary: Return All Legacy Backup Restore Jobs tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterRestoreJobs + x-xgen-operation-id-override: listClusterRestoreJobs post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: createLegacyBackupRestoreJob + operationId: createGroupClusterRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46601,7 +46932,8 @@ paths: summary: Create One Legacy Backup Restore Job tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createGroupClusterRestoreJob + x-xgen-operation-id-override: createClusterRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -46612,7 +46944,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacyBackupRestoreJob + operationId: getGroupClusterRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46638,8 +46970,8 @@ paths: schema: $ref: '#/components/schemas/BackupRestoreJob' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -46655,11 +46987,12 @@ paths: summary: Return One Legacy Backup Restore Job tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterRestoreJob + x-xgen-operation-id-override: getClusterRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: description: Deletes the Search Nodes for the specified cluster. - operationId: deleteAtlasSearchDeployment + operationId: deleteGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46698,12 +47031,13 @@ paths: summary: Delete Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchDeployment + x-xgen-operation-id-override: deleteClusterSearchDeployment x-xgen-atlascli: watcher: get: version: "2024-05-30" - operation-id: getAtlasSearchDeployment + operation-id: deleteGroupClusterSearchDeployment params: clusterName: input:clusterName groupId: input:groupId @@ -46711,7 +47045,7 @@ paths: http-code: 404 get: description: Returns the Search Nodes for the specified cluster. - operationId: getAtlasSearchDeployment + operationId: getGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46756,13 +47090,14 @@ paths: - Atlas Search x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchDeployment x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getClusterSearchDeployment patch: description: Updates the Search Nodes for the specified cluster. - operationId: updateAtlasSearchDeployment + operationId: updateGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46812,12 +47147,13 @@ paths: summary: Update Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchDeployment + x-xgen-operation-id-override: updateClusterSearchDeployment x-xgen-atlascli: watcher: get: version: "2024-05-30" - operation-id: getAtlasSearchDeployment + operation-id: updateGroupClusterSearchDeployment params: clusterName: input:clusterName groupId: input:groupId @@ -46828,7 +47164,7 @@ paths: - IDLE post: description: Creates Search Nodes for the specified cluster. - operationId: createAtlasSearchDeployment + operationId: createGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46881,12 +47217,13 @@ paths: summary: Create Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchDeployment + x-xgen-operation-id-override: createClusterSearchDeployment x-xgen-atlascli: watcher: get: version: "2024-05-30" - operation-id: getAtlasSearchDeployment + operation-id: updateGroupClusterSearchDeployment params: clusterName: input:clusterName groupId: input:groupId @@ -46901,7 +47238,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexesCluster + operationId: listGroupClusterSearchIndexes parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46922,7 +47259,7 @@ paths: $ref: '#/components/schemas/SearchIndexResponse' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -46944,13 +47281,14 @@ paths: summary: Return All Atlas Search Indexes for One Cluster tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndexes + x-xgen-operation-id-override: listClusterSearchIndexes post: description: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: createAtlasSearchIndex + operationId: createGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46992,14 +47330,15 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchIndex + x-xgen-operation-id-override: createClusterSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: description: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexes + operationId: listGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47032,7 +47371,7 @@ paths: $ref: '#/components/schemas/SearchIndexResponse' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -47054,14 +47393,18 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndex + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: description: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndexByName + operationId: deleteGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47110,13 +47453,17 @@ paths: summary: Remove One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndexByName + x-xgen-method-verb-override: + customMethod: true + verb: deleteByName + x-xgen-operation-id-override: deleteIndexByName get: description: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndexByName + operationId: getGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47167,10 +47514,11 @@ paths: summary: Return One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndexByName x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: getByName + x-xgen-operation-id-override: getIndexByName x-xgen-atlascli: override: description: | @@ -47180,7 +47528,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndexByName + operationId: updateGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47240,17 +47588,18 @@ paths: summary: Update One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndexByName x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: updateByName + x-xgen-operation-id-override: updateIndexByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndex + operationId: deleteGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47290,13 +47639,14 @@ paths: summary: Remove One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndex + x-xgen-operation-id-override: deleteClusterSearchIndex get: description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndex + operationId: getGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47344,7 +47694,8 @@ paths: summary: Return One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndex + x-xgen-operation-id-override: getClusterSearchIndex x-xgen-atlascli: override: description: | @@ -47354,7 +47705,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndex + operationId: updateGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47405,7 +47756,8 @@ paths: summary: Update One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndex + x-xgen-operation-id-override: updateClusterSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: deprecated: true @@ -47416,7 +47768,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacySnapshotSchedule + operationId: getGroupClusterSnapshotSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47435,7 +47787,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasSnapshotScheduleView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47449,7 +47801,8 @@ paths: summary: Return One Snapshot Schedule tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshotSchedule + x-xgen-operation-id-override: getClusterSnapshotSchedule patch: deprecated: true description: |- @@ -47459,7 +47812,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: updateLegacySnapshotSchedule + operationId: updateGroupClusterSnapshotSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47499,7 +47852,8 @@ paths: summary: Update Snapshot Schedule for One Cluster tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshotSchedule + x-xgen-operation-id-override: updateClusterSnapshotSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -47507,7 +47861,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: listLegacySnapshots + operationId: listGroupClusterSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47551,7 +47905,8 @@ paths: summary: Return All Legacy Backup Snapshots tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterSnapshots + x-xgen-operation-id-override: listClusterSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -47559,7 +47914,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: deleteLegacySnapshot + operationId: deleteGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47597,14 +47952,15 @@ paths: summary: Remove One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteGroupClusterSnapshot + x-xgen-operation-id-override: deleteClusterSnapshot get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacySnapshot + operationId: getGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47630,7 +47986,7 @@ paths: schema: $ref: '#/components/schemas/BackupSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47644,14 +48000,15 @@ paths: summary: Return One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshot + x-xgen-operation-id-override: getClusterSnapshot patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: updateLegacySnapshotRetention + operationId: updateGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47696,11 +48053,12 @@ paths: summary: Update Expiration Date for One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshot + x-xgen-operation-id-override: updateClusterSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getClusterStatus + operationId: getGroupClusterStatus parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47719,7 +48077,7 @@ paths: schema: $ref: '#/components/schemas/ClusterStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47733,11 +48091,12 @@ paths: summary: Return Status of All Cluster Operations tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterStatus + x-xgen-operation-id-override: getClusterStatus /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: post: description: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. - operationId: grantMongoDbEmployeeAccess + operationId: grantGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47778,11 +48137,12 @@ paths: summary: Grant MongoDB Employee Cluster Access for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantGroupClusterMongoDbEmployeeAccess + x-xgen-operation-id-override: grantMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. - operationId: pinFeatureCompatibilityVersion + operationId: pinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47822,11 +48182,12 @@ paths: summary: Pin Feature Compatibility Version for One Cluster in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinGroupClusterFeatureCompatibilityVersion + x-xgen-operation-id-override: pinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: post: description: Revokes a previously granted MongoDB employee cluster access. - operationId: revokeMongoDbEmployeeAccess + operationId: revokeGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47859,11 +48220,12 @@ paths: summary: Revoke MongoDB Employee Cluster Access for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeGroupClusterMongoDbEmployeeAccess + x-xgen-operation-id-override: revokeMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. - operationId: unpinFeatureCompatibilityVersion + operationId: unpinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47898,11 +48260,12 @@ paths: summary: Unpin Feature Compatibility Version for One Cluster in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinGroupClusterFeatureCompatibilityVersion + x-xgen-operation-id-override: unpinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn''t available for `M0` free clusters, `M2`, `M5`, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: getHostLogs + operationId: downloadGroupClusterLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47988,10 +48351,11 @@ paths: summary: Download Logs for One Cluster Host in One Project tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/downloadGroupClusterLog x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadClusterLog requestBody: content: application/vnd.atlas.2023-02-01+gzip: @@ -48003,7 +48367,7 @@ paths: /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listCloudProviderRegions + operationId: listGroupClusterProviderRegions parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48042,14 +48406,15 @@ paths: summary: Return All Cloud Provider Regions tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusterProviderRegions + x-xgen-operation-id-override: listClusterProviderRegions /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/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 - operationId: upgradeSharedCluster + operationId: upgradeGroupClusterTenantUpgrade parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48086,10 +48451,11 @@ paths: summary: Upgrade One Shared-Tier Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgrade x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: upgrade + x-xgen-operation-id-override: upgradeTenantUpgrade /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: deprecated: true @@ -48100,7 +48466,7 @@ paths: externalDocs: description: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster - operationId: upgradeSharedClusterToServerless + operationId: upgradeGroupClusterTenantUpgradeToServerless parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48138,14 +48504,15 @@ paths: summary: Upgrade One Shared-Tier Cluster to One Serverless Instance tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgradeToServerless x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: upgrade + x-xgen-operation-id-override: upgradeClusterToServerless /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. - operationId: getCollStatsLatencyNamespaceMetrics + operationId: listGroupCollStatMetrics parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -48165,14 +48532,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return all metric names + summary: Return All Metric Names tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupCollStatMetrics + x-xgen-operation-id-override: listCollStatMetrics /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringContainerByCloudProvider + operationId: listGroupContainers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48192,7 +48560,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -48212,10 +48580,10 @@ paths: summary: Return All Network Peering Containers in One Project for One Cloud Provider tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainers post: description: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createPeeringContainer + operationId: createGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48250,11 +48618,11 @@ paths: summary: Create One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupContainer /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePeeringContainer + operationId: deleteGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48288,10 +48656,10 @@ paths: summary: Remove One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupContainer get: description: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPeeringContainer + operationId: getGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48311,7 +48679,7 @@ paths: schema: $ref: '#/components/schemas/CloudProviderContainer' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48325,10 +48693,10 @@ paths: summary: Return One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupContainer patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updatePeeringContainer + operationId: updateGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48371,11 +48739,11 @@ paths: summary: Update One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupContainer /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringContainers + operationId: listGroupContainerAll parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48402,14 +48770,14 @@ paths: summary: Return All Network Peering Containers in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainerAll x-xgen-method-verb-override: customMethod: "False" verb: list /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listCustomDatabaseRoles + operationId: listGroupCustomDbRoleRoles parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48423,7 +48791,7 @@ paths: $ref: '#/components/schemas/UserCustomDBRole' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48437,10 +48805,11 @@ paths: summary: Return All Custom Roles in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listGroupCustomDbRoleRoles + x-xgen-operation-id-override: listCustomDbRoles post: description: Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: createCustomDatabaseRole + operationId: createGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48475,11 +48844,12 @@ paths: summary: Create One Custom Role tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createGroupCustomDbRoleRole + x-xgen-operation-id-override: createCustomDbRole /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: deleteCustomDatabaseRole + operationId: deleteGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48511,10 +48881,11 @@ paths: summary: Remove One Custom Role from One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteGroupCustomDbRoleRole + x-xgen-operation-id-override: deleteCustomDbRole get: description: Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getCustomDatabaseRole + operationId: getGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48544,10 +48915,11 @@ paths: summary: Return One Custom Role in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getGroupCustomDbRoleRole + x-xgen-operation-id-override: getCustomDbRole patch: description: Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: updateCustomDatabaseRole + operationId: updateGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48588,11 +48960,12 @@ paths: summary: Update One Custom Role in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateGroupCustomDbRoleRole + x-xgen-operation-id-override: updateCustomDbRole /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. - operationId: listFederatedDatabases + operationId: listGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48615,11 +48988,11 @@ paths: $ref: '#/components/schemas/DataLakeTenant' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48633,10 +49006,11 @@ paths: summary: Return All Federated Database Instances in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederation + x-xgen-operation-id-override: listDataFederation post: description: Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: createFederatedDatabase + operationId: createGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48675,11 +49049,12 @@ paths: summary: Create One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupDataFederation + x-xgen-operation-id-override: createDataFederation /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: deleteFederatedDatabase + operationId: deleteGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48707,10 +49082,11 @@ paths: summary: Remove One Federated Database Instance from One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederation + x-xgen-operation-id-override: deleteDataFederation get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: getFederatedDatabase + operationId: getGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48727,8 +49103,8 @@ paths: schema: $ref: '#/components/schemas/DataLakeTenant' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -48744,10 +49120,11 @@ paths: summary: Return One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederation + x-xgen-operation-id-override: getDataFederation patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. - operationId: updateFederatedDatabase + operationId: updateGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48792,11 +49169,12 @@ paths: summary: Update One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateGroupDataFederation + x-xgen-operation-id-override: updateDataFederation /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnFederatedDatabaseQueryLimits + operationId: listGroupDataFederationLimits parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48816,11 +49194,11 @@ paths: $ref: '#/components/schemas/DataFederationTenantQueryLimit' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48834,11 +49212,12 @@ paths: summary: Return All Query Limits for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederationLimits + x-xgen-operation-id-override: listDataFederationLimits /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteOneDataFederationInstanceQueryLimit + operationId: deleteGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48886,10 +49265,11 @@ paths: summary: Delete One Query Limit for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederationLimit + x-xgen-operation-id-override: deleteDataFederationLimit get: description: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnFederatedDatabaseQueryLimit + operationId: getGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48926,7 +49306,7 @@ paths: schema: $ref: '#/components/schemas/DataFederationTenantQueryLimit' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48940,10 +49320,11 @@ paths: summary: Return One Federated Database Instance Query Limit for One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederationLimit + x-xgen-operation-id-override: getDataFederationLimit patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createOneDataFederationQueryLimit + operationId: setGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49000,14 +49381,15 @@ paths: summary: Configure One Query Limit for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/setGroupDataFederationLimit x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: set + x-xgen-operation-id-override: setDataFederationLimit /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: downloadFederatedDatabaseQueryLogs + operationId: downloadGroupDataFederationQueryLogs parameters: - $ref: '#/components/parameters/groupId' - description: Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. @@ -49057,14 +49439,15 @@ paths: summary: Download Query Logs for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadGroupDataFederationQueryLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadFederationQueryLogs /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDatabaseUsers + operationId: listGroupDatabaseUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49091,13 +49474,14 @@ paths: summary: Return All Database Users in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listGroupDatabaseUsers + x-xgen-operation-id-override: listDatabaseUsers post: description: Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. externalDocs: description: Contact MongoDB Support url: https://cloud.mongodb.com/support - operationId: createDatabaseUser + operationId: createGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49223,11 +49607,12 @@ paths: summary: Create One Database User in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createGroupDatabaseUser + x-xgen-operation-id-override: createDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: deleteDatabaseUser + operationId: deleteGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49259,9 +49644,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. responses: "204": content: @@ -49279,10 +49664,11 @@ paths: summary: Remove One Database User from One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteGroupDatabaseUser + x-xgen-operation-id-override: deleteDatabaseUser get: description: Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabaseUser + operationId: getGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49314,9 +49700,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. responses: "200": content: @@ -49336,10 +49722,11 @@ paths: summary: Return One Database User from One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getGroupDatabaseUser + x-xgen-operation-id-override: getDatabaseUser patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: updateDatabaseUser + operationId: updateGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49371,9 +49758,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -49404,11 +49791,12 @@ paths: summary: Update One Database User in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateGroupDatabaseUser + x-xgen-operation-id-override: updateDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDatabaseUserCertificates + operationId: listGroupDatabaseUserCerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49443,7 +49831,8 @@ paths: summary: Return All X.509 Certificates Assigned to One Database User tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listGroupDatabaseUserCerts + x-xgen-operation-id-override: listDatabaseUserCerts post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -49454,7 +49843,7 @@ paths: externalDocs: description: Self-Managed X.509 url: https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509 - operationId: createDatabaseUserCertificate + operationId: createGroupDatabaseUserCert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49496,14 +49885,15 @@ paths: summary: Create One X.509 Certificate for One Database User tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createGroupDatabaseUserCert + x-xgen-operation-id-override: createDatabaseUserCert /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ - operationId: listAccessLogsByClusterName + operationId: getGroupDbAccessHistoryCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49570,14 +49960,15 @@ paths: summary: Return Database Access History for One Cluster by Cluster Name tags: - Access Tracking - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryCluster + x-xgen-operation-id-override: getAccessHistoryCluster /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ - operationId: listAccessLogsByHostname + operationId: getGroupDbAccessHistoryProcess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49641,14 +50032,15 @@ paths: summary: Return Database Access History for One Cluster by Hostname tags: - Access Tracking - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryProcess + x-xgen-operation-id-override: getAccessHistoryProcess /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. **LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. - operationId: getEncryptionAtRest + operationId: getGroupEncryptionAtRest parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49660,8 +50052,8 @@ paths: schema: $ref: '#/components/schemas/EncryptionAtRest' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -49672,16 +50064,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project + summary: Return One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRest + x-xgen-operation-id-override: getEncryptionAtRest patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. - operationId: updateEncryptionAtRest + operationId: updateGroupEncryptionAtRest parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49698,7 +50091,7 @@ paths: - To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object. - To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object. - - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object. + - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object For authentication, you must provide either serviceAccountKey (static credentials) or roleId (service-account–based authentication) Once roleId is configured, serviceAccountKey is no longer supported. If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint. required: true @@ -49722,14 +50115,15 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Update Encryption at Rest Configuration for One Project + summary: Update Encryption at Rest Configuration in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateGroupEncryptionAtRest + x-xgen-operation-id-override: updateEncryptionAtRest /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. - operationId: getEncryptionAtRestPrivateEndpointsForCloudProvider + operationId: listGroupEncryptionAtRestPrivateEndpoints parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49762,13 +50156,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project + summary: Return Private Endpoints for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/listGroupEncryptionAtRestPrivateEndpoints + x-xgen-operation-id-override: listRestPrivateEndpoints post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. - operationId: createEncryptionAtRestPrivateEndpoint + operationId: createGroupEncryptionAtRestPrivateEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49805,14 +50200,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management + summary: Create One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createGroupEncryptionAtRestPrivateEndpoint + x-xgen-operation-id-override: createRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - operationId: requestEncryptionAtRestPrivateEndpointDeletion + operationId: requestGroupEncryptionAtRestPrivateEndpointDeletion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49847,16 +50243,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Delete One Private Endpoint for Encryption at Rest Using Customer Key Management + summary: Delete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestGroupEncryptionAtRestPrivateEndpointDeletion x-xgen-method-verb-override: customMethod: "True" verb: requestDeletion + x-xgen-operation-id-override: requestPrivateEndpointDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - operationId: getEncryptionAtRestPrivateEndpoint + operationId: getGroupEncryptionAtRestPrivateEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49884,7 +50281,7 @@ paths: schema: $ref: '#/components/schemas/EARPrivateEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -49895,17 +50292,18 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management + summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRestPrivateEndpoint + x-xgen-operation-id-override: getRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/events: get: description: |- Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listProjectEvents + operationId: listGroupEvents parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49973,7 +50371,7 @@ paths: schema: $ref: '#/components/schemas/GroupPaginatedEventView' x-xgen-IPA-exception: - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -49991,7 +50389,7 @@ paths: summary: Return Events from One Project tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listGroupEvents /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -50001,7 +50399,7 @@ paths: externalDocs: description: Return Events from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents - operationId: getProjectEvent + operationId: getGroupEvent parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50026,7 +50424,7 @@ paths: schema: $ref: '#/components/schemas/EventViewForNdsGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -50040,11 +50438,11 @@ paths: summary: Return One Event from One Project tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getGroupEvent /api/atlas/v2/groups/{groupId}/flexClusters: get: description: Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listFlexClusters + operationId: listGroupFlexClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50073,10 +50471,11 @@ paths: summary: Return All Flex Clusters from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listGroupFlexClusters + x-xgen-operation-id-override: listFlexClusters post: description: Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createFlexCluster + operationId: createGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50113,14 +50512,14 @@ paths: summary: Create One Flex Cluster in One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createGroupFlexCluster + x-xgen-operation-id-override: createFlexCluster x-xgen-atlascli: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: createGroupFlexCluster params: - name: body:$.name groupId: input:groupId expect: match: @@ -50131,7 +50530,7 @@ paths: /api/atlas/v2/groups/{groupId}/flexClusters/{name}: delete: description: Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteFlexCluster + operationId: deleteGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -50164,12 +50563,13 @@ paths: summary: Remove One Flex Cluster from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteGroupFlexCluster + x-xgen-operation-id-override: deleteFlexCluster x-xgen-atlascli: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: deleteGroupFlexCluster params: name: input:name groupId: input:groupId @@ -50177,7 +50577,7 @@ paths: http-code: 404 get: description: Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getFlexCluster + operationId: getGroupFlexCluster parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50196,7 +50596,7 @@ paths: schema: $ref: '#/components/schemas/FlexClusterDescription20241113' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-11-13" description: OK "400": @@ -50214,10 +50614,11 @@ paths: summary: Return One Flex Cluster from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getGroupFlexCluster + x-xgen-operation-id-override: getFlexCluster patch: description: Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateFlexCluster + operationId: updateGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50259,12 +50660,13 @@ paths: summary: Update One Flex Cluster in One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateGroupFlexCluster + x-xgen-operation-id-override: updateFlexCluster x-xgen-atlascli: watcher: get: version: "2024-11-13" - operation-id: getFlexCluster + operation-id: updateGroupFlexCluster params: name: input:name groupId: input:groupId @@ -50276,7 +50678,7 @@ paths: /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download: post: description: Requests one snapshot for the specified flex cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: downloadFlexBackup + operationId: downloadGroupFlexClusterBackup parameters: - description: Human-readable label that identifies the flex cluster. in: path @@ -50318,13 +50720,14 @@ paths: summary: Download One Flex Cluster Snapshot tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadGroupFlexClusterBackup x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: downloadFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: description: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listFlexBackupRestoreJobs + operationId: listGroupFlexClusterBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50360,10 +50763,11 @@ paths: summary: Return All Restore Jobs for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listGroupFlexClusterBackupRestoreJobs + x-xgen-operation-id-override: listFlexRestoreJobs post: description: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createFlexBackupRestoreJob + operationId: createGroupFlexClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50402,19 +50806,19 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Flex Cluster + summary: Create One Restore Job for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createGroupFlexClusterBackupRestoreJob + x-xgen-operation-id-override: createFlexRestoreJob x-xgen-atlascli: watcher: get: version: "2024-11-13" - operation-id: getFlexBackupRestoreJob + operation-id: createGroupFlexClusterBackupRestoreJob params: name: input:name groupId: input:groupId - restoreJobId: body:$.id expect: match: path: $.status @@ -50424,7 +50828,7 @@ paths: /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getFlexBackupRestoreJob + operationId: getGroupFlexClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50464,11 +50868,12 @@ paths: summary: Return One Restore Job for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getGroupFlexClusterBackupRestoreJob + x-xgen-operation-id-override: getFlexRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots: get: description: Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listFlexBackups + operationId: listGroupFlexClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50501,14 +50906,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Snapshots of One Flex Cluster + summary: Return All Snapshots for One Flex Cluster tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listGroupFlexClusterBackupSnapshots + x-xgen-operation-id-override: listFlexBackupSnapshots /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getFlexBackup + operationId: getGroupFlexClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50545,14 +50951,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Snapshot of One Flex Cluster + summary: Return One Snapshot for One Flex Cluster tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getGroupFlexClusterBackupSnapshot + x-xgen-operation-id-override: getFlexBackupSnapshot /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: post: description: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. - operationId: upgradeFlexCluster + operationId: tenantGroupFlexClusterUpgrade parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50589,11 +50996,12 @@ paths: summary: Upgrade One Flex Cluster tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/tenantGroupFlexClusterUpgrade + x-xgen-operation-id-override: tenantUpgrade /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: listMetricTypes + operationId: listGroupHostFtsMetrics parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/groupId' @@ -50621,11 +51029,12 @@ paths: summary: Return All Atlas Search Metric Types for One Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetrics + x-xgen-operation-id-override: listHostFtsMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: getIndexMetrics + operationId: getGroupHostFtsMetricIndexMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/indexName' @@ -50667,7 +51076,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementsIndexes' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50685,11 +51094,12 @@ paths: summary: Return Atlas Search Metrics for One Index in One Namespace tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupHostFtsMetricIndexMeasurements + x-xgen-operation-id-override: getIndexMeasurements /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. - operationId: listIndexMetrics + operationId: listGroupHostFtsMetricIndexMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/databaseName' @@ -50730,7 +51140,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementsIndexes' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50748,11 +51158,15 @@ paths: summary: Return All Atlas Search Index Metrics for One Namespace tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricIndexMeasurements + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listIndexMeasurements /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: getMeasurements + operationId: listGroupHostFtsMetricMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/groupId' @@ -50808,11 +51222,12 @@ paths: summary: Return Atlas Search Hardware and Status Metrics tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricMeasurements + x-xgen-operation-id-override: listMeasurements /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: listThirdPartyIntegrations + operationId: listGroupIntegrations parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50841,11 +51256,11 @@ paths: summary: Return All Active Third-Party Service Integrations tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listGroupIntegrations /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: deleteThirdPartyIntegration + operationId: deleteGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -50887,10 +51302,10 @@ paths: summary: Remove One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteGroupIntegration get: description: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: getThirdPartyIntegration + operationId: getGroupIntegration parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50920,7 +51335,7 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyIntegration' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50936,10 +51351,10 @@ paths: summary: Return One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getGroupIntegration post: description: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per `{INTEGRATION-TYPE}`. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: createThirdPartyIntegration + operationId: createGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -50992,13 +51407,13 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Configure One Third-Party Service Integration + summary: Create One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createGroupIntegration put: description: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: updateThirdPartyIntegration + operationId: updateGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -51038,7 +51453,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedIntegrationView' x-xgen-IPA-exception: - xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51054,12 +51469,12 @@ paths: summary: Update One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateGroupIntegration /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true description: Returns all pending invitations to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listProjectInvitations + operationId: listGroupInvites parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51079,12 +51494,12 @@ paths: $ref: '#/components/schemas/GroupInvitation' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51095,14 +51510,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Project Invitations + summary: Return All Invitations in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupInvites patch: deprecated: true description: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectInvitation + operationId: updateGroupInvites parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51133,10 +51548,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Project Invitation + summary: Update One Invitation in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInvites x-xgen-atlascli: override: description: | @@ -51144,7 +51559,7 @@ paths: post: deprecated: true description: Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createProjectInvitation + operationId: createGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' @@ -51173,15 +51588,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Invite One MongoDB Cloud User to One Project + summary: Create Invitation for One MongoDB Cloud User in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroupInvite /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProjectInvitation + operationId: deleteGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51207,14 +51622,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Remove One Project Invitation + summary: Remove One Invitation from One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupInvite get: deprecated: true description: Returns the details of one pending invitation to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getProjectInvitation + operationId: getGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51234,7 +51649,7 @@ paths: $ref: '#/components/schemas/GroupInvitation' x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51245,14 +51660,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Project Invitation + summary: Return One Invitation in One Project by Invitation ID tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupInvite patch: deprecated: true description: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectInvitationById + operationId: updateGroupInviteById parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51289,10 +51704,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Project Invitation by Invitation ID + summary: Update One Invitation in One Project by Invitation ID tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInviteById + x-xgen-method-verb-override: + customMethod: false + verb: updateById + x-xgen-operation-id-override: updateInviteById x-xgen-atlascli: override: description: | @@ -51300,7 +51719,7 @@ paths: /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: Returns all IP addresses for this project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnAllIpAddresses + operationId: getGroupIpAddresses parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -51312,7 +51731,7 @@ paths: schema: $ref: '#/components/schemas/GroupIPAddresses' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51326,11 +51745,11 @@ paths: summary: Return All IP Addresses for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupIpAddresses /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listProjectLimits + operationId: listGroupLimits parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51344,11 +51763,11 @@ paths: $ref: '#/components/schemas/DataFederationLimit' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51366,21 +51785,21 @@ paths: summary: Return All Limits for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupLimits /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProjectLimit + operationId: deleteGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -51389,7 +51808,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -51408,7 +51826,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51434,20 +51851,20 @@ paths: summary: Remove One Project Limit tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupLimit get: description: Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectLimit + operationId: getGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -51456,7 +51873,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -51475,7 +51891,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51487,7 +51902,7 @@ paths: schema: $ref: '#/components/schemas/DataFederationLimit' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51505,23 +51920,23 @@ paths: summary: Return One Limit for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupLimit patch: description: |- Sets the specified project limit. To use this resource, the requesting Service Account or API Key must have the Project Owner role. **NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. - operationId: setProjectLimit + operationId: setGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -51530,7 +51945,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -51549,7 +51963,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51584,7 +51997,7 @@ paths: summary: Set One Project Limit tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setGroupLimit x-xgen-method-verb-override: customMethod: "True" verb: set @@ -51601,7 +52014,7 @@ paths: externalDocs: description: Validate Migration url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration - operationId: createPushMigration + operationId: createGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51641,14 +52054,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Migrate One Local Managed Cluster to MongoDB Atlas + summary: Create One Migration for One Local Managed Cluster to MongoDB Atlas tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createGroupLiveMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. - operationId: getPushMigration + operationId: getGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/liveMigrationId' @@ -51673,11 +52086,11 @@ paths: summary: Return One Migration Job tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: cutoverMigration + operationId: cutoverGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/liveMigrationId' @@ -51702,13 +52115,14 @@ paths: summary: Cut Over One Migrated Cluster tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverGroupLiveMigration x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: cutoverMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: validateMigration + operationId: validateGroupLiveMigrations parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51751,13 +52165,14 @@ paths: summary: Validate One Migration Request tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateGroupLiveMigrations x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: validateLiveMigrations /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: getValidationStatus + operationId: getGroupLiveMigrationValidateStatus parameters: - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal digit string that identifies the validation job. @@ -51790,14 +52205,15 @@ paths: summary: Return One Migration Validation Job tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigrationValidateStatus x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: getStatus + x-xgen-operation-id-override: getMigrationValidateStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: resetMaintenanceWindow + operationId: resetGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51820,13 +52236,14 @@ paths: summary: Reset One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetGroupMaintenanceWindow x-xgen-method-verb-override: customMethod: "True" verb: reset + x-xgen-operation-id-override: resetMaintenanceWindow get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getMaintenanceWindow + operationId: getGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51838,7 +52255,7 @@ paths: schema: $ref: '#/components/schemas/GroupMaintenanceWindow' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51852,10 +52269,11 @@ paths: summary: Return One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getGroupMaintenanceWindow + x-xgen-operation-id-override: getMaintenanceWindow patch: description: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateMaintenanceWindow + operationId: updateGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51885,11 +52303,12 @@ paths: summary: Update One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateGroupMaintenanceWindow + x-xgen-operation-id-override: updateMaintenanceWindow /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: toggleMaintenanceAutoDefer + operationId: toggleGroupMaintenanceWindowAutoDefer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51912,14 +52331,15 @@ paths: summary: Toggle Automatic Deferral of Maintenance for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleGroupMaintenanceWindowAutoDefer x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleMaintenanceAutoDefer /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deferMaintenanceWindow + operationId: deferGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51942,13 +52362,14 @@ paths: summary: Defer One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferGroupMaintenanceWindow x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: deferMaintenanceWindow /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. - operationId: getManagedSlowMs + operationId: getGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51960,7 +52381,7 @@ paths: schema: type: boolean x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51976,11 +52397,12 @@ paths: summary: Return Managed Slow Operation Threshold Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupManagedSlowMs + x-xgen-operation-id-override: getManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: disableSlowOperationThresholding + operationId: disableGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52004,13 +52426,14 @@ paths: summary: Disable Managed Slow Operation Threshold tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableGroupManagedSlowMs x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: disableManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: enableSlowOperationThresholding + operationId: enableGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52034,13 +52457,14 @@ paths: summary: Enable Managed Slow Operation Threshold tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableGroupManagedSlowMs x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: enableManagedSlowMs /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. - operationId: getProjectLtsVersions + operationId: getGroupMongoDbVersions parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -52085,8 +52509,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAvailableVersionView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52104,11 +52528,12 @@ paths: summary: Return All Available MongoDB LTS Versions for Clusters in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupMongoDbVersions + x-xgen-operation-id-override: getMongoDbVersions /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringConnections + operationId: listGroupPeers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52127,7 +52552,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -52149,13 +52574,13 @@ paths: summary: Return All Network Peering Connections in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupPeers post: description: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: description: Azure Network Peering Prerequisites url: https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites - operationId: createPeeringConnection + operationId: createGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52190,11 +52615,11 @@ paths: summary: Create One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupPeer /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePeeringConnection + operationId: deleteGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52227,10 +52652,10 @@ paths: summary: Remove One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupPeer get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPeeringConnection + operationId: getGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52249,7 +52674,7 @@ paths: schema: $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52265,10 +52690,10 @@ paths: summary: Return One Network Peering Connection in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupPeer patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updatePeeringConnection + operationId: updateGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52310,12 +52735,12 @@ paths: summary: Update One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupPeer /api/atlas/v2/groups/{groupId}/pipelines: get: deprecated: true description: Returns a list of Data Lake Pipelines. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelines + operationId: listGroupPipelines parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52328,12 +52753,12 @@ paths: $ref: '#/components/schemas/DataLakeIngestionPipeline' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation - x-sunset: "2025-09-09" + xgen-IPA-124-array-max-items: Schema predates IPA validation. + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52349,14 +52774,15 @@ paths: summary: Return All Data Lake Pipelines in One Project tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelines + x-xgen-operation-id-override: listPipelines post: deprecated: true description: Creates one Data Lake Pipeline. externalDocs: description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide. url: https://dochub.mongodb.org/core/data-lake-deprecation - operationId: createPipeline + operationId: createGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52373,7 +52799,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52389,15 +52815,15 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createGroupPipeline + x-xgen-operation-id-override: createPipeline x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: createGroupPipeline params: groupId: input:groupId - pipelineName: body:$.name expect: match: path: $.state @@ -52407,7 +52833,7 @@ paths: delete: deprecated: true description: Removes one Data Lake Pipeline. - operationId: deletePipeline + operationId: deleteGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52422,7 +52848,7 @@ paths: "200": content: application/vnd.atlas.2023-01-01+json: - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "401": @@ -52436,12 +52862,13 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipeline + x-xgen-operation-id-override: deletePipeline x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: deleteGroupPipeline params: groupId: input:groupId pipelineName: input:pipelineName @@ -52450,7 +52877,7 @@ paths: get: deprecated: true description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPipeline + operationId: getGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52468,9 +52895,9 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52486,11 +52913,12 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipeline + x-xgen-operation-id-override: getPipeline patch: deprecated: true description: Updates one Data Lake Pipeline. - operationId: updatePipeline + operationId: updateGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52514,7 +52942,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52532,12 +52960,13 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updateGroupPipeline + x-xgen-operation-id-override: updatePipeline x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getPipeline + operation-id: updateGroupPipeline params: groupId: input:groupId pipelineName: input:pipelineName @@ -52550,7 +52979,7 @@ paths: get: deprecated: true description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineSchedules + operationId: getGroupPipelineAvailableSchedules parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52571,11 +53000,11 @@ paths: $ref: '#/components/schemas/DiskBackupApiPolicyItem' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation - x-sunset: "2025-09-09" + xgen-IPA-124-array-max-items: Schema predates IPA validation. + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52591,12 +53020,13 @@ paths: summary: Return All Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSchedules + x-xgen-operation-id-override: getAvailablePipelineSchedules /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: deprecated: true description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineSnapshots + operationId: getGroupPipelineAvailableSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52623,10 +53053,10 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedBackupSnapshotView' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52642,12 +53072,13 @@ paths: summary: Return All Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSnapshots + x-xgen-operation-id-override: getAvailablePipelineSnapshots /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: deprecated: true description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: pausePipeline + operationId: pauseGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52665,7 +53096,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52681,14 +53112,15 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pauseGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: pausePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: deprecated: true description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: resumePipeline + operationId: resumeGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52706,7 +53138,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52722,14 +53154,15 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumeGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: resumePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: deprecated: true description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineRuns + operationId: listGroupPipelineRuns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52744,7 +53177,7 @@ paths: format: date-time type: string x-xgen-IPA-exception: - xgen-IPA-121-date-time-fields-mention-iso-8601: Schema predates IPA validation + xgen-IPA-121-date-time-fields-mention-iso-8601: Schema predates IPA validation. - description: Human-readable label that identifies the Data Lake Pipeline. in: path name: pipelineName @@ -52758,7 +53191,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedPipelineRunView' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52774,12 +53207,13 @@ paths: summary: Return All Data Lake Pipeline Runs in One Project tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelineRuns + x-xgen-operation-id-override: listPipelineRuns /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. - operationId: deletePipelineRunDataset + operationId: deleteGroupPipelineRun parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52805,7 +53239,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/RequestAccepted' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: Accepted "400": @@ -52821,11 +53255,12 @@ paths: summary: Delete One Pipeline Run Dataset tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipelineRun + x-xgen-operation-id-override: deletePipelineRun get: deprecated: true description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPipelineRun + operationId: getGroupPipelineRun parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52851,9 +53286,9 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/IngestionPipelineRun' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52869,12 +53304,13 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineRun + x-xgen-operation-id-override: getPipelineRun /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. - operationId: triggerSnapshotIngestion + operationId: triggerGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52899,7 +53335,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/IngestionPipelineRun' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52915,13 +53351,14 @@ paths: summary: Trigger On-Demand Snapshot Ingestion tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: triggerPipeline /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPrivateEndpointServices + operationId: listGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52938,7 +53375,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -52948,11 +53385,11 @@ paths: $ref: '#/components/schemas/EndpointService' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52968,11 +53405,12 @@ paths: summary: Return All Private Endpoint Services for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: listPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePrivateEndpointService + operationId: deleteGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52989,7 +53427,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. in: path name: endpointServiceId @@ -53016,12 +53454,13 @@ paths: summary: Remove One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: deletePrivateEndpointService x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getPrivateEndpointService + operation-id: deleteGroupPrivateEndpointEndpointService params: cloudProvider: body:$.cloudProvider groupId: input:groupId @@ -53030,7 +53469,7 @@ paths: http-code: 404 get: description: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateEndpointService + operationId: getGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53047,7 +53486,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. in: path name: endpointServiceId @@ -53062,7 +53501,7 @@ paths: schema: $ref: '#/components/schemas/EndpointService' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -53078,11 +53517,12 @@ paths: summary: Return One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: getPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. - operationId: createPrivateEndpoint + operationId: createGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53099,7 +53539,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. in: path name: endpointServiceId @@ -53139,11 +53579,12 @@ paths: summary: Create One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: createPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePrivateEndpoint + operationId: deleteGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53160,7 +53601,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. in: path name: endpointId @@ -53194,10 +53635,11 @@ paths: summary: Remove One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: deletePrivateEndpoint get: description: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateEndpoint + operationId: getGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53214,7 +53656,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. in: path name: endpointId @@ -53236,7 +53678,7 @@ paths: schema: $ref: '#/components/schemas/PrivateLinkEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -53252,14 +53694,15 @@ paths: summary: Return One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: getPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Private Endpoint Concepts url: https://dochub.mongodb.org/core/private-endpoint-concepts - operationId: createPrivateEndpointService + operationId: createGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53292,16 +53735,15 @@ paths: summary: Create One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: createPrivateEndpointService x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getPrivateEndpointService + operation-id: createGroupPrivateEndpointEndpointService params: - cloudProvider: body:$.cloudProvider groupId: input:groupId - endpointServiceId: body:$.id expect: match: path: $.status @@ -53311,7 +53753,7 @@ paths: /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getRegionalizedPrivateEndpointSetting + operationId: getGroupPrivateEndpointRegionalMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53335,13 +53777,14 @@ paths: summary: Return Regionalized Private Endpoint Status tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointRegionalMode x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getRegionalEndpointMode patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. - operationId: toggleRegionalizedPrivateEndpointSetting + operationId: toggleGroupPrivateEndpointRegionalMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53374,17 +53817,18 @@ paths: summary: Toggle Regionalized Private Endpoint Status tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleGroupPrivateEndpointRegionalMode x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleRegionalEndpointMode /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: |- Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: listServerlessPrivateEndpoints + operationId: listGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53404,11 +53848,11 @@ paths: $ref: '#/components/schemas/ServerlessTenantEndpoint' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -53424,7 +53868,8 @@ paths: summary: Return All Private Endpoints for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: listServerlessPrivateEndpoint post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -53435,7 +53880,7 @@ paths: externalDocs: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint - operationId: createServerlessPrivateEndpoint + operationId: createGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53474,14 +53919,15 @@ paths: summary: Create One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: createServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: |- Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: deleteServerlessPrivateEndpoint + operationId: deleteGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53518,13 +53964,14 @@ paths: summary: Remove One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: deleteServerlessPrivateEndpoint get: description: |- Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: getServerlessPrivateEndpoint + operationId: getGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53549,7 +53996,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessTenantEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -53565,13 +54012,14 @@ paths: summary: Return One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: getServerlessPrivateEndpoint patch: description: |- Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: updateServerlessPrivateEndpoint + operationId: updateGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53617,7 +54065,8 @@ paths: summary: Update One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: updateServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -53625,7 +54074,7 @@ paths: externalDocs: description: Changes to Connection Strings url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/ - operationId: verifyConnectViaPeeringOnlyModeForOneProject + operationId: verifyGroupPrivateIpMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53637,7 +54086,7 @@ paths: schema: $ref: '#/components/schemas/PrivateIPModeView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53651,17 +54100,18 @@ paths: summary: Verify Connect via Peering-Only Mode for One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyGroupPrivateIpMode x-xgen-method-verb-override: customMethod: "True" verb: verify + x-xgen-operation-id-override: verifyPrivateIpMode patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Changes to Connection Strings url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/ - operationId: disablePeering + operationId: disableGroupPrivateIpModePeering parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53694,14 +54144,15 @@ paths: summary: Disable Connect via Peering-Only Mode for One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disableGroupPrivateIpModePeering x-xgen-method-verb-override: customMethod: "True" verb: disablePeering + x-xgen-operation-id-override: disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: listDataFederationPrivateEndpoints + operationId: listGroupPrivateNetworkSettingEndpointIds parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53730,7 +54181,8 @@ paths: summary: Return All Federated Database Instance and Online Archive Private Endpoints in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupPrivateNetworkSettingEndpointIds + x-xgen-operation-id-override: listPrivateEndpointIds post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -53752,7 +54204,7 @@ paths: `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: createDataFederationPrivateEndpoint + operationId: createGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53785,11 +54237,12 @@ paths: summary: Create One Federated Database Instance and Online Archive Private Endpoint for One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: createPrivateEndpointId /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteDataFederationPrivateEndpoint + operationId: deleteGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53818,10 +54271,11 @@ paths: summary: Remove One Federated Database Instance and Online Archive Private Endpoint from One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: deletePrivateEndpointId get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: getDataFederationPrivateEndpoint + operationId: getGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53854,11 +54308,12 @@ paths: summary: Return One Federated Database Instance and Online Archive Private Endpoint in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: getPrivateEndpointId /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listAtlasProcesses + operationId: listGroupProcesses parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53888,7 +54343,7 @@ paths: summary: Return All MongoDB Processes in One Project tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcesses requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -53900,7 +54355,7 @@ paths: /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getAtlasProcess + operationId: getGroupProcess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53920,7 +54375,7 @@ paths: schema: $ref: '#/components/schemas/ApiHostView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53934,11 +54389,11 @@ paths: summary: Return One MongoDB Process by ID tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcess /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace. - operationId: getCollStatsLatencyNamespaceHostMeasurements + operationId: listGroupProcessCollStatMeasurements parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/processId' @@ -54003,11 +54458,12 @@ paths: summary: Return Host-Level Query Latency tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupProcessCollStatMeasurements + x-xgen-operation-id-override: listProcessMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. - operationId: getCollStatsLatencyNamespacesForHost + operationId: getGroupProcessCollStatNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/processId' @@ -54031,20 +54487,21 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Ranked Namespaces from a Host + summary: Return Ranked Namespaces from One Host tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupProcessCollStatNamespaces x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getProcessNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Operational Limits url: https://www.mongodb.com/docs/atlas/reference/limitations/ - operationId: listDatabases + operationId: listGroupProcessDatabases parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54079,11 +54536,12 @@ paths: summary: Return Available Databases for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDatabases + x-xgen-operation-id-override: listDatabases /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabase + operationId: getGroupProcessDatabase parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54109,7 +54567,7 @@ paths: schema: $ref: '#/components/schemas/MesurementsDatabase' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54123,11 +54581,12 @@ paths: summary: Return One Database for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabase + x-xgen-operation-id-override: getDatabase /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabaseMeasurements + operationId: getGroupProcessDatabaseMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54179,7 +54638,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54193,11 +54652,12 @@ paths: summary: Return Measurements for One Database in One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabaseMeasurements + x-xgen-operation-id-override: getDatabaseMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDiskPartitions + operationId: listGroupProcessDisks parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54232,11 +54692,12 @@ paths: summary: Return Available Disks for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDisks + x-xgen-operation-id-override: listProcessDisks /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDiskMeasurements + operationId: getGroupProcessDisk parameters: - $ref: '#/components/parameters/envelope' - description: Human-readable label of the disk or partition to which the measurements apply. @@ -54261,7 +54722,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementDiskPartition' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54275,7 +54736,8 @@ paths: summary: Return Measurements for One Disk tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDisk + x-xgen-operation-id-override: getProcessDisk /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -54286,7 +54748,7 @@ paths: - Amount of free and used disk space on the disk partition used for the MongoDB process To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDiskMeasurements + operationId: getGroupProcessDiskMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54350,7 +54812,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54364,7 +54826,8 @@ paths: summary: Return Measurements of One Disk for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDiskMeasurements + x-xgen-operation-id-override: getProcessDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -54376,7 +54839,7 @@ paths: - Measurements for the host, such as CPU usage or number of I/O operations To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getHostMeasurements + operationId: getGroupProcessMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54552,7 +55015,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54566,11 +55029,12 @@ paths: summary: Return Measurements for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessMeasurements + x-xgen-operation-id-override: getProcessMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSlowQueryNamespaces + operationId: listGroupProcessPerformanceAdvisorNamespaces parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54626,11 +55090,12 @@ paths: summary: Return All Namespaces for One Host tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorNamespaces + x-xgen-operation-id-override: listPerformanceAdvisorNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. - operationId: listSlowQueries + operationId: listGroupProcessPerformanceAdvisorSlowQueryLogs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54721,11 +55186,12 @@ paths: summary: Return Slow Queries tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSlowQueryLogs + x-xgen-operation-id-override: listSlowQueryLogs /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSuggestedIndexes + operationId: listGroupProcessPerformanceAdvisorSuggestedIndexes parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54805,11 +55271,12 @@ paths: summary: Return All Suggested Indexes tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSuggestedIndexes + x-xgen-operation-id-override: listSuggestedIndexes /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. - operationId: deletePushBasedLogConfiguration + operationId: deleteGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54833,10 +55300,11 @@ paths: summary: Disable Push-Based Log Export for One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deleteGroupPushBasedLogExport + x-xgen-operation-id-override: deleteLogExport get: description: Fetches the current project level settings for the push-based log export feature. - operationId: getPushBasedLogConfiguration + operationId: getGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54860,16 +55328,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Push-Based Log Export Configuration for One Project + summary: Return One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getGroupPushBasedLogExport x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getLogExport patch: description: Updates the project level settings for the push-based log export feature. - operationId: updatePushBasedLogConfiguration + operationId: updateGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54898,13 +55367,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update Push-Based Log Export for One Project + summary: Update One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updateGroupPushBasedLogExport + x-xgen-operation-id-override: updateLogExport post: description: Configures the project level settings for the push-based log export feature. - operationId: createPushBasedLogConfiguration + operationId: createGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54933,14 +55403,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Enable Push-Based Log Export for One Project + summary: Create One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createGroupPushBasedLogExport + x-xgen-operation-id-override: createLogExport /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: loadSampleDataset + operationId: requestGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54974,18 +55445,19 @@ paths: summary: Load Sample Dataset into One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/requestGroupSampleDatasetLoad x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: request + x-xgen-operation-id-override: requestSampleDatasetLoad x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getSampleDatasetLoadStatus + operation-id: requestGroupSampleDatasetLoad params: groupId: input:groupId - sampleDatasetId: body:$.id + name: input:name expect: match: path: $.state @@ -54995,7 +55467,7 @@ paths: /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getSampleDatasetLoadStatus + operationId: getGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55013,7 +55485,7 @@ paths: schema: $ref: '#/components/schemas/SampleDatasetStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -55027,7 +55499,8 @@ paths: summary: Return Status of Sample Dataset Load for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupSampleDatasetLoad + x-xgen-operation-id-override: getSampleDatasetLoad /api/atlas/v2/groups/{groupId}/serverless: get: description: |- @@ -55037,7 +55510,7 @@ paths: externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters - operationId: listServerlessInstances + operationId: listGroupServerlessInstances parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55066,7 +55539,11 @@ paths: summary: Return All Serverless Instances in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listGroupServerlessInstances + x-xgen-method-verb-override: + customMethod: false + verb: listInstances + x-xgen-operation-id-override: listServerlessInstances post: description: |- Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. @@ -55075,7 +55552,7 @@ paths: externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster - operationId: createServerlessInstance + operationId: createGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55112,15 +55589,18 @@ paths: summary: Create One Serverless Instance in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: createInstance + x-xgen-operation-id-override: createServerlessInstance x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: createGroupServerlessInstance params: groupId: input:groupId - name: body:$.name expect: match: path: $.status @@ -55135,7 +55615,7 @@ paths: externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs - operationId: listServerlessBackupRestoreJobs + operationId: listGroupServerlessBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55171,7 +55651,8 @@ paths: summary: Return All Restore Jobs for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupRestoreJobs + x-xgen-operation-id-override: listServerlessRestoreJobs post: description: |- Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -55180,7 +55661,7 @@ paths: externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob - operationId: createServerlessBackupRestoreJob + operationId: createGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55219,10 +55700,11 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Serverless Instance + summary: Create One Restore Job for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupServerlessBackupRestoreJob + x-xgen-operation-id-override: createServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: |- @@ -55232,7 +55714,7 @@ paths: externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob - operationId: getServerlessBackupRestoreJob + operationId: getGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55258,7 +55740,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessBackupRestoreJob' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -55274,7 +55756,8 @@ paths: summary: Return One Restore Job for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupRestoreJob + x-xgen-operation-id-override: getServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: |- @@ -55284,7 +55767,7 @@ paths: externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups - operationId: listServerlessBackups + operationId: listGroupServerlessBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55320,7 +55803,8 @@ paths: summary: Return All Snapshots of One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupSnapshots + x-xgen-operation-id-override: listServerlessBackupSnapshots /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: |- @@ -55330,7 +55814,7 @@ paths: externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup - operationId: getServerlessBackup + operationId: getGroupServerlessBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55356,7 +55840,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessBackupSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -55372,14 +55856,15 @@ paths: summary: Return One Snapshot of One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupSnapshot + x-xgen-operation-id-override: getServerlessBackupSnapshot /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: description: createServerlessInstance url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance - operationId: getServerlessAutoIndexing + operationId: getGroupServerlessPerformanceAdvisorAutoIndexing parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -55412,16 +55897,17 @@ paths: summary: Return Serverless Auto-Indexing Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupServerlessPerformanceAdvisorAutoIndexing x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getServerlessAutoIndexing post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: description: createServerlessInstance url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance - operationId: setServerlessAutoIndexing + operationId: setGroupServerlessPerformanceAdvisorAutoIndexing parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -55457,10 +55943,11 @@ paths: summary: Set Serverless Auto-Indexing Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setGroupServerlessPerformanceAdvisorAutoIndexing x-xgen-method-verb-override: customMethod: "True" verb: set + x-xgen-operation-id-override: setServerlessAutoIndexing /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: |- @@ -55470,7 +55957,7 @@ paths: externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster - operationId: deleteServerlessInstance + operationId: deleteGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55505,12 +55992,16 @@ paths: summary: Remove One Serverless Instance from One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: deleteInstance + x-xgen-operation-id-override: deleteServerlessInstance x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: deleteGroupServerlessInstance params: groupId: input:groupId name: input:name @@ -55524,7 +56015,7 @@ paths: externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster - operationId: getServerlessInstance + operationId: getGroupServerlessInstance parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -55543,7 +56034,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessInstanceDescription' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -55561,7 +56052,11 @@ paths: summary: Return One Serverless Instance from One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: getInstance + x-xgen-operation-id-override: getServerlessInstance patch: description: |- Updates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -55570,7 +56065,7 @@ paths: externalDocs: description: updateFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster - operationId: updateServerlessInstance + operationId: updateGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55612,12 +56107,16 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: updateInstance + x-xgen-operation-id-override: updateServerlessInstance x-xgen-atlascli: watcher: get: - version: "2024-11-13" - operation-id: getFlexCluster + version: "2023-01-01" + operation-id: updateGroupServerlessInstance params: groupId: input:groupId name: input:name @@ -55629,7 +56128,7 @@ paths: /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns all Service Accounts for the specified Project. - operationId: listProjectServiceAccounts + operationId: listGroupServiceAccounts parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/itemsPerPage' @@ -55655,10 +56154,10 @@ paths: summary: Return All Project Service Accounts tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccounts post: description: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. - operationId: createProjectServiceAccount + operationId: createGroupServiceAccount parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -55692,11 +56191,11 @@ paths: summary: Create One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: description: Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. - operationId: deleteProjectServiceAccount + operationId: deleteGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -55727,10 +56226,10 @@ paths: summary: Remove One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccount get: description: Returns one Service Account in the specified Project. - operationId: getProjectServiceAccount + operationId: getGroupServiceAccount parameters: - $ref: '#/components/parameters/groupId' - description: The Client ID of the Service Account. @@ -55750,7 +56249,7 @@ paths: schema: $ref: '#/components/schemas/GroupServiceAccount' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -55764,10 +56263,10 @@ paths: summary: Return One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getGroupServiceAccount patch: description: Updates one Service Account in the specified Project. - operationId: updateProjectServiceAccount + operationId: updateGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -55808,11 +56307,11 @@ paths: summary: Update One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateGroupServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: get: description: Returns all access list entries that you configured for the specified Service Account for the project. - operationId: listProjectServiceAccountAccessList + operationId: listGroupServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -55847,10 +56346,11 @@ paths: summary: Return All Access List Entries for One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccountAccessList + x-xgen-operation-id-override: listAccessList post: description: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. - operationId: createProjectServiceAccountAccessList + operationId: createGroupServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -55900,11 +56400,12 @@ paths: summary: Add Access List Entries for One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountAccessList + x-xgen-operation-id-override: createAccessList /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. - operationId: deleteProjectServiceAccountAccessListEntry + operationId: deleteGroupServiceAccountAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55944,11 +56445,15 @@ paths: summary: Remove One Access List Entry from One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: deleteEntry + x-xgen-operation-id-override: deleteGroupAccessEntry /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets: post: description: Create a secret for the specified Service Account in the specified Project. - operationId: createProjectServiceAccountSecret + operationId: createGroupServiceAccountSecret parameters: - $ref: '#/components/parameters/groupId' - description: The Client ID of the Service Account. @@ -55989,11 +56494,12 @@ paths: summary: Create One Project Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountSecret + x-xgen-operation-id-override: createGroupSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: description: Deletes the specified Service Account secret. - operationId: deleteProjectServiceAccountSecret + operationId: deleteGroupServiceAccountSecret parameters: - description: The Client ID of the Service Account. in: path @@ -56029,11 +56535,12 @@ paths: summary: Delete One Project Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountSecret + x-xgen-operation-id-override: deleteGroupSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: post: description: Assigns the specified Service Account to the specified Project. - operationId: addProjectServiceAccount + operationId: inviteGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -56073,11 +56580,11 @@ paths: summary: Assign One Service Account to One Project tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/inviteGroupServiceAccount /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectSettings + operationId: getGroupSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56089,7 +56596,7 @@ paths: schema: $ref: '#/components/schemas/GroupSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -56103,10 +56610,10 @@ paths: summary: Return Project Settings tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupSettings patch: description: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectSettings + operationId: updateGroupSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56137,11 +56644,11 @@ paths: summary: Update Project Settings tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupSettings /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. - operationId: listStreamInstances + operationId: listGroupStreamWorkspaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56169,10 +56676,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamWorkspaces + x-xgen-method-verb-override: + customMethod: false + verb: listWorkspaces + x-xgen-operation-id-override: listStreamWorkspaces post: description: Creates one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: createStreamInstance + operationId: createGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56207,11 +56718,15 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: createWorkspace + x-xgen-operation-id-override: createStreamWorkspace /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamInstance + operationId: deleteGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56241,10 +56756,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: deleteWorkspace + x-xgen-operation-id-override: deleteStreamWorkspace get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: getStreamInstance + operationId: getGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56266,7 +56785,7 @@ paths: schema: $ref: '#/components/schemas/StreamsTenant' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" description: OK "400": @@ -56284,10 +56803,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: getWorkspace + x-xgen-operation-id-override: getStreamWorkspace patch: description: Update one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: updateStreamInstance + operationId: updateGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56328,11 +56851,15 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: updateWorkspace + x-xgen-operation-id-override: updateStreamWorkspace /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: downloadStreamTenantAuditLogs + operationId: downloadGroupStreamAuditLogs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56383,14 +56910,15 @@ paths: summary: Download Audit Logs for One Atlas Stream Processing Instance tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadGroupStreamAuditLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadAuditLogs /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: listStreamConnections + operationId: listGroupStreamConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56424,14 +56952,15 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamConnections + x-xgen-operation-id-override: listStreamConnections x-xgen-atlascli: override: description: | Returns all connections of the stream instance for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: createStreamConnection + operationId: createGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56474,11 +57003,12 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamConnection + x-xgen-operation-id-override: createStreamConnection /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamConnection + operationId: deleteGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56516,10 +57046,11 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamConnection + x-xgen-operation-id-override: deleteStreamConnection get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getStreamConnection + operationId: getGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56542,7 +57073,7 @@ paths: schema: $ref: '#/components/schemas/StreamsConnection' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" description: OK "401": @@ -56558,10 +57089,11 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamConnection + x-xgen-operation-id-override: getStreamConnection patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: updateStreamConnection + operationId: updateGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56610,11 +57142,12 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamConnection + x-xgen-operation-id-override: updateStreamConnection /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor: post: description: Create one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: createStreamProcessor + operationId: createGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56655,11 +57188,12 @@ paths: summary: Create One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamProcessor + x-xgen-operation-id-override: createStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: description: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamProcessor + operationId: deleteGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56693,10 +57227,11 @@ paths: summary: Delete One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamProcessor + x-xgen-operation-id-override: deleteStreamProcessor get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: getStreamProcessor + operationId: getGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56720,7 +57255,7 @@ paths: schema: $ref: '#/components/schemas/StreamsProcessorWithStats' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -56736,10 +57271,11 @@ paths: summary: Return One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessor + x-xgen-operation-id-override: getStreamProcessor patch: description: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: modifyStreamProcessor + operationId: updateGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56784,11 +57320,12 @@ paths: summary: Update One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamProcessor + x-xgen-operation-id-override: updateStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: startStreamProcessor + operationId: startGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56822,11 +57359,12 @@ paths: summary: Start One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessor + x-xgen-operation-id-override: startStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: startStreamProcessorWith + operationId: startGroupStreamProcessorWith parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56867,11 +57405,12 @@ paths: summary: Start One Stream Processor With Options tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessorWith + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessorWith + x-xgen-operation-id-override: startStreamProcessorWith /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: description: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: stopStreamProcessor + operationId: stopGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56905,11 +57444,12 @@ paths: summary: Stop One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopGroupStreamProcessor + x-xgen-operation-id-override: stopStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: description: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: listStreamProcessors + operationId: getGroupStreamProcessors parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56930,8 +57470,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -56947,11 +57487,12 @@ paths: summary: Return All Stream Processors in One Stream Instance tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessors + x-xgen-operation-id-override: getStreamProcessors /api/atlas/v2/groups/{groupId}/streams/accountDetails: get: description: Returns the Account ID, and the VPC ID for the group and region specified. - operationId: getAccountDetails + operationId: getGroupStreamAccountDetails parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56986,14 +57527,15 @@ paths: summary: Return Account ID and VPC ID for One Project and Region tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamAccountDetails x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getAccountDetails /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: description: Returns a list of active incoming VPC Peering Connections. - operationId: getActiveVpcPeeringConnections + operationId: listGroupStreamActiveVpcPeeringConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -57017,11 +57559,12 @@ paths: summary: Return All Active Incoming VPC Peering Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamActiveVpcPeeringConnections + x-xgen-operation-id-override: listActivePeeringConnections /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: get: description: Returns all Private Link connections for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: listPrivateLinkConnections + operationId: listGroupStreamPrivateLinkConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -57049,14 +57592,15 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamPrivateLinkConnections + x-xgen-operation-id-override: listPrivateLinkConnections x-xgen-atlascli: override: description: | Returns all Private Link connections for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. post: description: Creates one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: createPrivateLinkConnection + operationId: createGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57093,11 +57637,12 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: createPrivateLinkConnection /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: delete: description: Deletes one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: deletePrivateLinkConnection + operationId: deleteGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57127,10 +57672,11 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: deletePrivateLinkConnection get: description: Returns the details of one Private Link connection within the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateLinkConnection + operationId: getGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57161,11 +57707,12 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: getPrivateLinkConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: get: description: Returns a list of incoming VPC Peering Connections. - operationId: getVpcPeeringConnections + operationId: listGroupStreamVpcPeeringConnections parameters: - description: The Account ID of the VPC Peering connection/s. in: query @@ -57195,11 +57742,12 @@ paths: summary: Return All VPC Peering Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamVpcPeeringConnections + x-xgen-operation-id-override: listVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: delete: description: Deletes an incoming VPC Peering connection. - operationId: deleteVpcPeeringConnection + operationId: deleteGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57226,11 +57774,12 @@ paths: summary: Delete One VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: deleteVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: post: description: Requests the acceptance of an incoming VPC Peering connection. - operationId: acceptVpcPeeringConnection + operationId: acceptGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57264,11 +57813,12 @@ paths: summary: Accept One Incoming VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: acceptVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: post: description: Requests the rejection of an incoming VPC Peering connection. - operationId: rejectVpcPeeringConnection + operationId: rejectGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57295,11 +57845,12 @@ paths: summary: Reject One Incoming VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: rejectVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: post: description: Creates one stream instance in the specified project with sample connections. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: createStreamInstanceWithSampleConnections + operationId: withGroupStreamSampleConnections parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57332,11 +57883,12 @@ paths: summary: Create One Stream Instance with Sample Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/withGroupStreamSampleConnections + x-xgen-operation-id-override: withStreamSampleConnections /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listProjectTeams + operationId: listGroupTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57365,13 +57917,13 @@ paths: summary: Return All Teams in One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listGroupTeams post: description: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: addAllTeamsToProject + operationId: addGroupTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57406,7 +57958,7 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addGroupTeams x-xgen-method-verb-override: customMethod: "True" verb: add @@ -57420,7 +57972,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: removeProjectTeam + operationId: removeGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57450,13 +58002,13 @@ paths: summary: Remove One Team from One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeGroupTeam x-xgen-method-verb-override: customMethod: "True" verb: remove 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 + operationId: getGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57475,7 +58027,7 @@ paths: schema: $ref: '#/components/schemas/TeamRole' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -57491,13 +58043,13 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getGroupTeam 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: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: updateTeamRoles + operationId: updateGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57523,7 +58075,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedTeamRoleView' x-xgen-IPA-exception: - xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -57539,11 +58091,11 @@ paths: summary: Update Team Roles in One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateGroupTeam /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getLdapConfiguration + operationId: getGroupUserSecurity parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57555,8 +58107,8 @@ paths: schema: $ref: '#/components/schemas/UserSecurity' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -57570,13 +58122,14 @@ paths: summary: Return LDAP or X.509 Configuration tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurity + x-xgen-operation-id-override: getUserSecurity patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. - operationId: saveLdapConfiguration + operationId: updateGroupUserSecurity parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57609,14 +58162,15 @@ paths: summary: Update LDAP or X.509 Configuration tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/updateGroupUserSecurity + x-xgen-operation-id-override: updateUserSecurity /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. - operationId: disableCustomerManagedX509 + operationId: disableGroupUserSecurityCustomerX509 parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57639,14 +58193,15 @@ paths: summary: Disable Customer-Managed X.509 tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableGroupUserSecurityCustomerX509 x-xgen-method-verb-override: customMethod: "True" verb: disable + x-xgen-operation-id-override: disableSecurityCustomerX509 /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteLdapConfiguration + operationId: deleteGroupUserSecurityLdapUserToDnMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57670,11 +58225,12 @@ paths: summary: Remove LDAP User to DN Mapping tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteGroupUserSecurityLdapUserToDnMapping + x-xgen-operation-id-override: deleteLdapUserMapping /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: verifyLdapConfiguration + operationId: verifyGroupUserSecurityLdap parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57707,17 +58263,17 @@ paths: summary: Verify LDAP Configuration in One Project tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyGroupUserSecurityLdap x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: verifyUserSecurityLdap x-xgen-atlascli: watcher: get: version: "2023-01-01" - operation-id: getLdapConfigurationStatus + operation-id: verifyGroupUserSecurityLdap params: groupId: input:groupId - requestId: body:$.requestId expect: match: path: $.status @@ -57727,7 +58283,7 @@ paths: /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getLdapConfigurationStatus + operationId: getGroupUserSecurityLdapVerify parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57758,10 +58314,11 @@ paths: summary: Return Status of LDAP Configuration Verification in One Project tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurityLdapVerify x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getUserSecurityVerify /api/atlas/v2/groups/{groupId}/users: get: description: |- @@ -57773,7 +58330,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: listProjectUsers + operationId: listGroupUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57829,10 +58386,10 @@ paths: summary: Return All MongoDB Cloud Users in One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listGroupUsers post: description: "Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. \n- If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. \n- If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. \n- If the user is already active in the project's organization, MongoDB Cloud grants access to the project. \n" - operationId: addProjectUser + operationId: addGroupUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57867,7 +58424,7 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUsers x-xgen-method-verb-override: customMethod: "True" verb: add @@ -57882,7 +58439,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeProjectUser + operationId: removeGroupUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57918,7 +58475,7 @@ paths: summary: Remove One MongoDB Cloud User from One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUser x-xgen-method-verb-override: customMethod: "True" verb: remove @@ -57929,7 +58486,7 @@ paths: **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. - operationId: getProjectUser + operationId: getGroupUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57962,12 +58519,12 @@ paths: summary: Return One MongoDB Cloud User in One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getGroupUser /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: deprecated: true description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - operationId: updateProjectRoles + operationId: updateGroupUserRoles parameters: - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal digit string that identifies the user to modify. @@ -58006,7 +58563,7 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupUserRoles /api/atlas/v2/groups/{groupId}/users/{userId}:addRole: post: description: |- @@ -58016,7 +58573,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: addProjectRole + operationId: addGroupUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -58058,7 +58615,7 @@ paths: summary: Add One Project Role to One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUserRole /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole: post: description: |- @@ -58068,7 +58625,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeProjectRole + operationId: removeGroupUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -58110,11 +58667,11 @@ paths: summary: Remove One Project Role from One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUserRole /api/atlas/v2/groups/{groupId}:migrate: post: description: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: migrateProjectToAnotherOrg + operationId: migrateGroup parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -58144,11 +58701,11 @@ paths: summary: Migrate One Project to Another Organization tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateGroup /api/atlas/v2/groups/byName/{groupName}: get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectByName + operationId: getGroupByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -58183,7 +58740,7 @@ paths: summary: Return One Project by Name tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupByName x-xgen-atlascli: override: description: | @@ -58191,7 +58748,7 @@ paths: /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: listOrganizations + operationId: listOrgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58226,13 +58783,13 @@ paths: summary: Return All Organizations tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgs post: description: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. externalDocs: description: Configure a Paying Organization url: https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization - operationId: createOrganization + operationId: createOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -58250,7 +58807,7 @@ paths: schema: $ref: '#/components/schemas/CreateOrganizationResponse' x-xgen-IPA-exception: - xgen-IPA-106-create-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-106-create-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: Created "400": @@ -58268,7 +58825,7 @@ paths: summary: Create One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrg /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -58277,7 +58834,7 @@ paths: - Organizations with active projects cannot be removed. - All projects in the organization must be removed before you can remove the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: deleteOrganization + operationId: deleteOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58304,10 +58861,10 @@ paths: summary: Remove One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrg get: description: Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: getOrganization + operationId: getOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58319,7 +58876,7 @@ paths: schema: $ref: '#/components/schemas/AtlasOrganization' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58337,10 +58894,10 @@ paths: summary: Return One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrg patch: description: Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateOrganization + operationId: updateOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58375,14 +58932,14 @@ paths: summary: Update One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrg /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: listApiKeys + operationId: listOrgApiKeys parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58409,13 +58966,13 @@ paths: summary: Return All Organization API Keys tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeys post: description: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: createApiKey + operationId: createOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58446,14 +59003,14 @@ paths: summary: Create One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: deleteApiKey + operationId: deleteOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58482,13 +59039,13 @@ paths: summary: Remove One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKey get: description: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: getApiKey + operationId: getOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58507,7 +59064,7 @@ paths: schema: $ref: '#/components/schemas/ApiKeyUserDetails' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -58521,13 +59078,13 @@ paths: summary: Return One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKey patch: description: Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: updateApiKey + operationId: updateOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58567,14 +59124,14 @@ paths: summary: Update One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateOrgApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization - operationId: listApiKeyAccessListsEntries + operationId: listOrgApiKeyAccessListEntries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58608,10 +59165,14 @@ paths: summary: Return All Access List Entries for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeyAccessListEntries + x-xgen-method-verb-override: + customMethod: false + verb: listEntries + x-xgen-operation-id-override: listOrgAccessEntries post: description: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. - operationId: createApiKeyAccessList + operationId: createOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58658,14 +59219,18 @@ paths: summary: Create One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: createEntry + x-xgen-operation-id-override: createOrgAccessEntry /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: deleteApiKeyAccessListEntry + operationId: deleteOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58704,16 +59269,17 @@ paths: summary: Remove One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKeyAccessListEntry x-xgen-method-verb-override: customMethod: "True" verb: deleteEntry + x-xgen-operation-id-override: deleteAccessEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: getApiKeyAccessList + operationId: getOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58752,11 +59318,15 @@ paths: summary: Return One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: getEntry + x-xgen-operation-id-override: getOrgAccessEntry /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. - operationId: createCostExplorerQueryProcess + operationId: createOrgBillingCostExplorerUsageProcess parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58788,11 +59358,15 @@ paths: summary: Create One Cost Explorer Query Process tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createOrgBillingCostExplorerUsageProcess + x-xgen-method-verb-override: + customMethod: false + verb: createProcess + x-xgen-operation-id-override: createCostExplorerProcess /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. - operationId: getCostExplorerQueryProcess + operationId: getOrgBillingCostExplorerUsage parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58839,17 +59413,18 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return results from a given Cost Explorer query, or notify that the results are not ready yet. + summary: Return Usage Details for One Cost Explorer Query tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgBillingCostExplorerUsage + x-xgen-operation-id-override: getCostExplorerUsage /api/atlas/v2/orgs/{orgId}/events: get: description: |- Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This resource remains under revision and may change. - operationId: listOrganizationEvents + operationId: listOrgEvents parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58898,7 +59473,7 @@ paths: schema: $ref: '#/components/schemas/OrgPaginatedEventView' x-xgen-IPA-exception: - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58914,7 +59489,7 @@ paths: summary: Return Events from One Organization tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrgEvents /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -58924,7 +59499,7 @@ paths: externalDocs: description: Return Events from One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents - operationId: getOrganizationEvent + operationId: getOrgEvent parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58949,7 +59524,7 @@ paths: schema: $ref: '#/components/schemas/EventViewForOrg' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -58963,11 +59538,11 @@ paths: summary: Return One Event from One Organization tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrgEvent /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. - operationId: getFederationSettings + operationId: getOrgFederationSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58979,7 +59554,7 @@ paths: schema: $ref: '#/components/schemas/OrgFederationSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58995,7 +59570,8 @@ paths: summary: Return Federation Settings for One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getOrgFederationSettings + x-xgen-operation-id-override: getFederationSettings /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -59007,7 +59583,7 @@ paths: - Create different alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: listOrganizationProjects + operationId: getOrgGroups parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -59027,9 +59603,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAtlasGroupView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -59045,7 +59620,7 @@ paths: summary: Return All Projects in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgGroups /api/atlas/v2/orgs/{orgId}/invites: get: deprecated: true @@ -59056,7 +59631,7 @@ paths: externalDocs: description: Return All MongoDB Cloud Users in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers - operationId: listOrganizationInvitations + operationId: listOrgInvites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59076,12 +59651,12 @@ paths: $ref: '#/components/schemas/OrganizationInvitation' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -59094,10 +59669,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Organization Invitations + summary: Return All Invitations in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgInvites patch: deprecated: true description: |- @@ -59107,7 +59682,7 @@ paths: externalDocs: description: Update One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser - operationId: updateOrganizationInvitation + operationId: updateOrgInvites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59138,10 +59713,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Organization Invitation + summary: Update One Invitation in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInvites x-xgen-atlascli: override: description: | @@ -59155,7 +59730,7 @@ paths: externalDocs: description: Add One MongoDB Cloud User to One url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser - operationId: createOrganizationInvitation + operationId: createOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59186,10 +59761,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Invite One MongoDB Cloud User to One Atlas Organization + summary: Create Invitation for One MongoDB Cloud User in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrgInvite /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: deprecated: true @@ -59200,7 +59775,7 @@ paths: externalDocs: description: Remove One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser - operationId: deleteOrganizationInvitation + operationId: deleteOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59228,10 +59803,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Remove One Organization Invitation + summary: Remove One Invitation from One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrgInvite get: deprecated: true description: |- @@ -59241,7 +59816,7 @@ paths: externalDocs: description: Return One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser - operationId: getOrganizationInvitation + operationId: getOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59260,7 +59835,7 @@ paths: $ref: '#/components/schemas/OrganizationInvitation' x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -59273,10 +59848,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Organization Invitation + summary: Return One Invitation in One Organization by Invitation ID tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgInvite patch: deprecated: true description: |- @@ -59286,7 +59861,7 @@ paths: externalDocs: description: Update One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser - operationId: updateOrganizationInvitationById + operationId: updateOrgInviteById parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59324,10 +59899,13 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Organization Invitation by Invitation ID + summary: Update One Invitation in One Organization by Invitation ID tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInviteById + x-xgen-method-verb-override: + customMethod: false + verb: updateById x-xgen-atlascli: override: description: | @@ -59337,7 +59915,7 @@ paths: description: |- Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: listInvoices + operationId: listOrgInvoices parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -59408,7 +59986,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedApiInvoiceMetadataView' x-xgen-IPA-exception: - xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation + xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -59422,13 +60000,14 @@ paths: summary: Return All Invoices for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoices + x-xgen-operation-id-override: listInvoices /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: getInvoice + operationId: getOrgInvoice parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59458,7 +60037,7 @@ paths: schema: $ref: '#/components/schemas/BillingInvoice' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -59472,13 +60051,14 @@ paths: summary: Return One Invoice for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoice + x-xgen-operation-id-override: getInvoice /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: downloadInvoiceCsv + operationId: getOrgInvoiceCsv parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59516,11 +60096,12 @@ paths: summary: Return One Invoice as CSV for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoiceCsv + x-xgen-operation-id-override: getInvoiceCsv /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: description: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. - operationId: queryLineItemsFromSingleInvoice + operationId: searchOrgInvoiceLineItems parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -59561,11 +60142,12 @@ paths: summary: Return All Line Items for One Invoice by Invoice ID tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/searchOrgInvoiceLineItems + x-xgen-operation-id-override: searchInvoiceLineItems /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. - operationId: listPendingInvoices + operationId: listOrgInvoicePending parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59589,11 +60171,12 @@ paths: summary: Return All Pending Invoices for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoicePending + x-xgen-operation-id-override: listInvoicePending /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. - operationId: listSourceProjects + operationId: listOrgLiveMigrationAvailableProjects parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -59607,7 +60190,7 @@ paths: $ref: '#/components/schemas/LiveImportAvailableProject' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -59623,11 +60206,12 @@ paths: summary: Return All Projects Available for Migration tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listOrgLiveMigrationAvailableProjects + x-xgen-operation-id-override: listAvailableProjects /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: deleteLinkToken + operationId: deleteOrgLiveMigrationLinkTokens parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -59650,10 +60234,11 @@ paths: summary: Remove One Link-Token tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteOrgLiveMigrationLinkTokens + x-xgen-operation-id-override: deleteLinkTokens post: description: Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: createLinkToken + operationId: createOrgLiveMigrationLinkToken parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -59686,14 +60271,15 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createOrgLiveMigrationLinkToken + x-xgen-operation-id-override: createLinkToken /api/atlas/v2/orgs/{orgId}/nonCompliantResources: get: description: Return all non-compliant resources for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getResourcesNonCompliant + operationId: getOrgNonCompliantResources parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -59707,10 +60293,10 @@ paths: $ref: '#/components/schemas/ApiAtlasNonCompliantResourceView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59726,7 +60312,8 @@ paths: summary: Return All Non-Compliant Resources tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgNonCompliantResources + x-xgen-operation-id-override: getNonCompliantResources /api/atlas/v2/orgs/{orgId}/resourcePolicies: get: description: Return all Atlas Resource Policies for the org. @@ -59747,11 +60334,11 @@ paths: $ref: '#/components/schemas/ApiAtlasResourcePolicyView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59881,7 +60468,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasResourcePolicyView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59959,7 +60546,7 @@ paths: externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: validateAtlasResourcePolicy + operationId: validateOrgResourcePolicies parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -59998,11 +60585,12 @@ paths: summary: Validate 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/validateAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateOrgResourcePolicies + x-xgen-operation-id-override: validateResourcePolicies /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns all Service Accounts for the specified Organization. - operationId: listServiceAccounts + operationId: listOrgServiceAccounts parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/itemsPerPage' @@ -60028,10 +60616,10 @@ paths: summary: Return All Organization Service Accounts tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccounts post: description: Creates one Service Account for the specified Organization. - operationId: createServiceAccount + operationId: createOrgServiceAccount parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -60064,11 +60652,11 @@ paths: summary: Create One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: description: Deletes the specified Service Account. - operationId: deleteServiceAccount + operationId: deleteOrgServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -60098,10 +60686,10 @@ paths: summary: Delete One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccount get: description: Returns the specified Service Account. - operationId: getServiceAccount + operationId: getOrgServiceAccount parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -60121,7 +60709,7 @@ paths: schema: $ref: '#/components/schemas/OrgServiceAccount' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -60135,10 +60723,10 @@ paths: summary: Return One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccount patch: description: Updates the specified Service Account in the specified Organization. - operationId: updateServiceAccount + operationId: updateOrgServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -60179,11 +60767,11 @@ paths: summary: Update One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateOrgServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList: get: description: Returns all access list entries that you configured for the specified Service Account for the organization. - operationId: listServiceAccountAccessList + operationId: listOrgServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -60218,10 +60806,11 @@ paths: summary: Return All Access List Entries for One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccountAccessList + x-xgen-operation-id-override: listOrgAccessList post: description: Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. - operationId: createServiceAccountAccessList + operationId: createOrgServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -60271,11 +60860,12 @@ paths: summary: Add Access List Entries for One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountAccessList + x-xgen-operation-id-override: createOrgAccessList /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified Service Account for the organization. You can't remove the requesting IP address from the access list. - operationId: deleteServiceAccountAccessListEntry + operationId: deleteOrgServiceAccountAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60315,14 +60905,15 @@ paths: summary: Remove One Access List Entry from One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountAccessListEntry x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: deleteEntry + x-xgen-operation-id-override: deleteOrgAccessEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: description: Returns a list of all projects the specified Service Account is a part of. - operationId: listServiceAccountProjects + operationId: getOrgServiceAccountGroups parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -60344,8 +60935,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedServiceAccountGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -60359,11 +60950,12 @@ paths: summary: Return All Service Account Project Assignments tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccountGroups + x-xgen-operation-id-override: getServiceAccountGroups /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: description: Create a secret for the specified Service Account. - operationId: createServiceAccountSecret + operationId: createOrgServiceAccountSecret parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -60404,11 +60996,12 @@ paths: summary: Create One Organization Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountSecret + x-xgen-operation-id-override: createOrgSecret /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: description: Deletes the specified Service Account secret. - operationId: deleteServiceAccountSecret + operationId: deleteOrgServiceAccountSecret parameters: - description: The Client ID of the Service Account. in: path @@ -60444,11 +61037,12 @@ paths: summary: Delete One Organization Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountSecret + x-xgen-operation-id-override: deleteOrgSecret /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 Member role. - operationId: getOrganizationSettings + operationId: getOrgSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60460,7 +61054,7 @@ paths: schema: $ref: '#/components/schemas/OrganizationSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -60474,10 +61068,10 @@ paths: summary: Return Settings for One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgSettings patch: description: Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateOrganizationSettings + operationId: updateOrgSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60512,14 +61106,14 @@ paths: summary: Update Settings for One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgSettings /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: listOrganizationTeams + operationId: listOrgTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -60548,13 +61142,13 @@ paths: summary: Return All Teams in One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrgTeams post: description: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: createTeam + operationId: createOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60589,14 +61183,14 @@ paths: summary: Create One Team in One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createOrgTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: deleteTeam + operationId: deleteOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60627,13 +61221,13 @@ paths: summary: Remove One Team from One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteOrgTeam get: description: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: getTeamById + operationId: getOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60666,13 +61260,13 @@ paths: summary: Return One Team by ID tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeam patch: description: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: renameTeam + operationId: renameOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60714,7 +61308,7 @@ paths: summary: Rename One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameOrgTeam x-xgen-method-verb-override: customMethod: "True" verb: rename @@ -60729,7 +61323,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: listTeamUsers + operationId: listOrgTeamUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -60789,7 +61383,8 @@ paths: summary: Return All MongoDB Cloud Users Assigned to One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgTeamUsers + x-xgen-operation-id-override: listTeamUsers post: deprecated: true description: |- @@ -60799,7 +61394,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: addTeamUser + operationId: addOrgTeamUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60844,10 +61439,11 @@ paths: summary: Assign MongoDB Cloud Users in One Organization to One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addOrgTeamUsers x-xgen-method-verb-override: customMethod: "True" verb: add + x-xgen-operation-id-override: addTeamUsers /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: deprecated: true @@ -60858,7 +61454,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: removeTeamUser + operationId: removeOrgTeamUserFromTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60897,10 +61493,11 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeOrgTeamUserFromTeam x-xgen-method-verb-override: customMethod: "True" - verb: remove + verb: removeFromTeam + x-xgen-operation-id-override: removeUserFromTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: post: description: |- @@ -60910,7 +61507,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project endpoint' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation - operationId: addUserToTeam + operationId: addOrgTeamUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60950,7 +61547,7 @@ paths: summary: Add One MongoDB Cloud User to One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser: post: description: |- @@ -60960,7 +61557,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeUserFromTeam + operationId: removeOrgTeamUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61000,14 +61597,14 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgTeamUser /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: getTeamByName + operationId: getOrgTeamByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61039,7 +61636,8 @@ paths: summary: Return One Team by Name tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeamByName + x-xgen-operation-id-override: getTeamByName /api/atlas/v2/orgs/{orgId}/users: get: description: |- @@ -61051,7 +61649,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: listOrganizationUsers + operationId: listOrgUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61097,13 +61695,13 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgUsers post: description: |- Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. - operationId: createOrganizationUser + operationId: createOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61138,7 +61736,7 @@ paths: summary: Add One MongoDB Cloud User to One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrgUser /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: |- @@ -61150,7 +61748,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeOrganizationUser + operationId: removeOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61186,7 +61784,7 @@ paths: summary: Remove One MongoDB Cloud User from One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUser x-xgen-method-verb-override: customMethod: "True" verb: remove @@ -61197,7 +61795,7 @@ paths: **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. - operationId: getOrganizationUser + operationId: getOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61230,7 +61828,7 @@ paths: summary: Return One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrgUser patch: description: |- Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -61241,7 +61839,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: updateOrganizationUser + operationId: updateOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61281,12 +61879,12 @@ paths: summary: Update One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrgUser /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: deprecated: true description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. - operationId: updateOrganizationRoles + operationId: updateOrgUserRoles parameters: - $ref: '#/components/parameters/orgId' - description: Unique 24-hexadecimal digit string that identifies the user to modify. @@ -61325,7 +61923,7 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgUserRoles /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: post: description: |- @@ -61337,7 +61935,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: addOrganizationRole + operationId: addOrgUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61379,7 +61977,8 @@ paths: summary: Add One Organization Role to One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgUserRole + x-xgen-operation-id-override: addOrgRole /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: post: description: |- @@ -61391,7 +61990,7 @@ paths: externalDocs: description: Invite One MongoDB Cloud User to Join One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeOrganizationRole + operationId: removeOrgUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -61431,11 +62030,12 @@ paths: summary: Remove One Organization Role from One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUserRole + x-xgen-operation-id-override: removeOrgRole /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. - operationId: returnAllControlPlaneIpAddresses + operationId: listControlPlaneIpAddresses parameters: - $ref: '#/components/parameters/envelope' responses: @@ -61445,9 +62045,9 @@ paths: schema: $ref: '#/components/schemas/ControlPlaneIPAddresses' x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-11-15" description: OK "500": @@ -61456,7 +62056,8 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/listControlPlaneIpAddresses + x-xgen-operation-id-override: listControlPlaneAddresses /api/atlas/v2/users: post: deprecated: true @@ -61524,7 +62125,7 @@ paths: $ref: '#/components/schemas/CloudAppUser' x-sunset: "9999-12-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -61546,7 +62147,7 @@ paths: externalDocs: description: Return One Organization API Key url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey - operationId: getUserByUsername + operationId: getUserByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -61577,7 +62178,7 @@ paths: summary: Return One MongoDB Cloud User by Username tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByName security: - ServiceAccounts: [] - DigestAuth: [] diff --git a/tools/internal/specs/spec.yaml b/tools/internal/specs/spec.yaml index afbf3078ad..0c5a60985e 100644 --- a/tools/internal/specs/spec.yaml +++ b/tools/internal/specs/spec.yaml @@ -927,6 +927,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -968,6 +970,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -1089,10 +1093,12 @@ components: mapping: aws: '#/components/schemas/AWSAccountDetails' azure: '#/components/schemas/AzureAccountDetails' + gcp: '#/components/schemas/GCPAccountDetails' propertyName: cloudProvider oneOf: - $ref: '#/components/schemas/AWSAccountDetails' - $ref: '#/components/schemas/AzureAccountDetails' + - $ref: '#/components/schemas/GCPAccountDetails' type: object AcknowledgeAlert: description: Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean. @@ -3766,7 +3772,7 @@ components: - name type: object AtlasResourcePolicyAuditForNdsGroup: - description: Atlas resource policy audits indicate org level changes to resource policies + description: Atlas resource policy audits indicate organization level changes to resource policies. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -3870,7 +3876,7 @@ components: title: Atlas Resource Policy Audits For NDS Group type: object AtlasResourcePolicyAuditForOrg: - description: Atlas resource policy audits indicate org level changes to resource policies + description: Atlas resource policy audits indicate organization level changes to resource policies. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -4003,7 +4009,7 @@ components: title: Atlas Search Analyzer type: object AtlasTenantClusterUpgradeRequest20240805: - description: Request containing target state of tenant cluster to be upgraded + description: Request containing target state of tenant cluster to be upgraded. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -4117,6 +4123,14 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + internalClusterRole: + description: 'Internal classification of the cluster''s role. Possible values: NONE (regular user cluster), SYSTEM_CLUSTER (system cluster for backup), INTERNAL_SHADOW_CLUSTER (internal use shadow cluster for testing).' + enum: + - NONE + - SYSTEM_CLUSTER + - INTERNAL_SHADOW_CLUSTER + readOnly: true + type: string labels: deprecated: true description: |- @@ -5190,6 +5204,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -5231,6 +5247,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -6260,6 +6278,8 @@ components: - M400_NVME title: AWS Instance Sizes type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - enum: - M10 - M20 @@ -6285,6 +6305,8 @@ components: - M600_NVME title: Azure Instance Sizes type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - enum: - M10 - M20 @@ -7150,7 +7172,7 @@ components: - metricName type: object ChartsAudit: - description: Audit events related to Atlas Charts + description: Audit events related to Atlas Charts. properties: apiKeyId: description: Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. @@ -8101,6 +8123,10 @@ components: AZURE: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' GCP: '#/components/schemas/CloudProviderAccessGCPServiceAccount' propertyName: providerName + oneOf: + - $ref: '#/components/schemas/CloudProviderAccessAWSIAMRole' + - $ref: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' + - $ref: '#/components/schemas/CloudProviderAccessGCPServiceAccount' properties: providerName: description: Human-readable label that identifies the cloud provider of the role. @@ -8329,6 +8355,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Microsoft Azure Regions. enum: - US_CENTRAL @@ -8386,6 +8414,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Google Compute Regions. enum: - EASTERN_US @@ -8440,6 +8470,8 @@ components: - ASIA_SOUTHEAST_2 title: GCP Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object title: Cloud Service Provider Settings for Multi-Cloud Clusters type: object @@ -8521,6 +8553,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Microsoft Azure Regions. enum: - US_CENTRAL @@ -8578,6 +8612,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - description: Google Compute Regions. enum: - EASTERN_US @@ -8632,6 +8668,8 @@ components: - ASIA_SOUTHEAST_2 title: GCP Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object title: Cloud Service Provider Settings type: object @@ -9096,6 +9134,14 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + internalClusterRole: + description: 'Internal classification of the cluster''s role. Possible values: NONE (regular user cluster), SYSTEM_CLUSTER (system cluster for backup), INTERNAL_SHADOW_CLUSTER (internal use shadow cluster for testing).' + enum: + - NONE + - SYSTEM_CLUSTER + - INTERNAL_SHADOW_CLUSTER + readOnly: true + type: string labels: deprecated: true description: |- @@ -10335,7 +10381,7 @@ components: description: Request body for a cost explorer query. properties: clusters: - description: The list of projects to be included in the Cost Explorer Query. + description: The list of clusters to be included in the Cost Explorer Query. items: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ @@ -10371,7 +10417,7 @@ components: type: string type: array services: - description: The list of projects to be included in the Cost Explorer Query. + description: The list of SKU services to be included in the Cost Explorer Query. items: enum: - Atlas @@ -10505,7 +10551,7 @@ components: title: AWS type: object CreateAtlasOrganizationApiKey: - description: Details of the programmatic API key to be created. + description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request. properties: desc: description: Purpose or explanation provided when someone created this organization API key. @@ -10835,11 +10881,23 @@ components: description: 'MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can''t use the empty document (`{}`) to return all documents. Set this parameter when **"criteria.type" : "CUSTOM"**.' type: string type: object - description: '**CUSTOM criteria.type**.' + description: Custom archival criteria. required: - query title: Archival Criteria type: object + CustomSessionTimeouts: + description: Defines the session timeout settings for managing user sessions at the organization level. When set to null, the field's value is unset, and the default timeout settings are applied. + properties: + absoluteSessionTimeoutInSeconds: + description: Specifies the absolute session timeout duration in seconds. When set to null, the field's value is unset, and the default value of 43,200 seconds (12 hours) is applied. Accepted values range between a minimum of 3,600 seconds (1 hour) and a maximum of 43,200 seconds (12 hours). + format: int32 + type: integer + idleSessionTimeoutInSeconds: + description: 'Specifies the idle session timeout duration in seconds. When set to null, the field''s value is unset, and the default behavior depends on the context: no timeout for Atlas Commercial, and 600 seconds (10 minutes) for Atlas for Government. Accepted values start at a minimum of 300 seconds (5 minutes). For Atlas Commercial, the maximum value cannot exceed the configured absolute session timeout. For Atlas for Government, the maximum value is capped at 600 seconds (10 minutes).' + format: int32 + type: integer + type: object CustomZoneMappings: properties: customZoneMappings: @@ -11232,7 +11290,6 @@ components: mapping: atlas.project.deployment.clusters: '#/components/schemas/DefaultLimit' atlas.project.deployment.nodesPerPrivateLinkRegion: '#/components/schemas/DefaultLimit' - atlas.project.deployment.salesSoldM0s: '#/components/schemas/DefaultLimit' atlas.project.deployment.serverlessMTMs: '#/components/schemas/DefaultLimit' atlas.project.security.databaseAccess.customRoles: '#/components/schemas/DefaultLimit' atlas.project.security.databaseAccess.users: '#/components/schemas/DefaultLimit' @@ -12816,6 +12873,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 + sendQueryStatsMetrics: + default: false + description: Toggle sending query shape metrics that includes query hash and metrics on latency, execution frequency, documents returned, and timestamps. + type: boolean sendUserProvidedResourceTags: default: false description: Toggle sending user provided group and cluster resource tags with the datadog metrics. @@ -12936,7 +12997,7 @@ components: format: int32 type: integer type: object - description: '**DATE criteria.type**.' + description: Date-Based archival criteria. title: Archival Criteria type: object DbDataSizeTotalDataMetricThresholdView: @@ -13134,6 +13195,8 @@ components: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13339,6 +13402,8 @@ components: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13558,6 +13623,7 @@ components: - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES + - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA title: Cluster Connection Audit Types type: string - enum: @@ -13665,6 +13731,10 @@ components: - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - ENCRYPTION_AT_REST_CONFIG_IS_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -13832,6 +13902,11 @@ components: - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS title: Access Event Types type: string + - enum: + - QUERY_SHAPE_BLOCKED + - QUERY_SHAPE_UNBLOCKED + title: Query Shape Event Types + type: string type: object groupId: description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. @@ -13945,6 +14020,8 @@ components: - ROLE_MAPPING_DELETED title: Federation Settings Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - GROUP_DELETED - GROUP_CREATED @@ -14062,7 +14139,7 @@ components: title: Any Other Events type: object DefaultLimit: - description: Details of user managed limits + description: Details of user managed limits. properties: currentUsage: description: Amount that indicates the current usage of the limit. @@ -14876,6 +14953,9 @@ components: url: https://www.mongodb.com/docs/atlas/security/set-up-unified-aws-access/ pattern: ^([a-f0-9]{24})$ type: string + requirePrivateNetworking: + description: Indicates whether to do exports over PrivateLink as opposed to public IPs. Defaults to False. + type: boolean type: object required: - bucketName @@ -14924,6 +15004,9 @@ components: example: us-east-1 readOnly: true type: string + requirePrivateNetworking: + description: Indicates whether to use privatelink. User supplied. + type: boolean required: - _id - bucketName @@ -15922,7 +16005,7 @@ components: description: One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index. type: object x-xgen-IPA-exception: - xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation + xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation. type: array name: description: Name of index. @@ -16054,6 +16137,8 @@ components: - NEW_ZEALAND_NORTH title: Azure Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers - 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. enum: - US_GOV_WEST_1 @@ -16095,6 +16180,8 @@ components: - GLOBAL title: AWS Regions type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Enum values standardized by cloud providers type: object status: description: State of the Encryption At Rest private endpoint. @@ -16318,7 +16405,7 @@ components: - CRITICAL type: string EventTypeDetails: - description: A singular type of event + description: A singular type of event. properties: alertable: description: Whether or not this event type can be configured as an alert via the API. @@ -16439,6 +16526,7 @@ components: - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES + - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA title: Cluster Connection Audit Types type: string - enum: @@ -16575,6 +16663,10 @@ components: - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - ENCRYPTION_AT_REST_CONFIG_IS_VALID + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING + - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED + - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED title: Group Event Types type: string - enum: @@ -16601,6 +16693,7 @@ components: - SSH_KEY_NDS_HOST_ACCESS_REFRESHED - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT - SSH_KEY_NDS_HOST_ACCESS_GRANTED + - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED - HOST_SSH_SESSION_ENDED - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS - PUSH_BASED_LOG_EXPORT_RESUMED @@ -16613,6 +16706,8 @@ components: - HOST_SECURITY_CHECKUP_NOT_MET title: Host Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - INSIDE_METRIC_THRESHOLD - OUTSIDE_METRIC_THRESHOLD @@ -16763,6 +16858,7 @@ components: - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED + - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED @@ -16822,6 +16918,18 @@ components: - PUSH_BASED_LOG_EXPORT_ENABLED - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED - PUSH_BASED_LOG_EXPORT_DISABLED + - LOG_STREAMING_ENABLED + - LOG_STREAMING_CONFIGURATION_UPDATED + - LOG_STREAMING_DISABLED + - DATADOG_LOG_STREAMING_ENABLED + - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED + - DATADOG_LOG_STREAMING_DISABLED + - SPLUNK_LOG_STREAMING_ENABLED + - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED + - SPLUNK_LOG_STREAMING_DISABLED + - S3_LOG_STREAMING_ENABLED + - S3_LOG_STREAMING_CONFIGURATION_UPDATED + - S3_LOG_STREAMING_DISABLED - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED - CONTAINER_DELETED - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED @@ -16858,8 +16966,12 @@ components: - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED + - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE + - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE title: NDS Audit Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - DB_CHECK_SUBMITTED - DB_CHECK_UPDATED @@ -17099,6 +17211,11 @@ components: - RESOURCE_POLICY_VIOLATED title: Atlas Resource Policy Audit Types type: string + - enum: + - QUERY_SHAPE_BLOCKED + - QUERY_SHAPE_UNBLOCKED + title: Query Shape Event Types + type: string type: object EventTypeForOrg: oneOf: @@ -17215,6 +17332,8 @@ components: - EVERGREEN_PRIORITY_MODIFIED title: Billing Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - FEDERATION_SETTINGS_CREATED - FEDERATION_SETTINGS_DELETED @@ -17242,6 +17361,8 @@ components: - ROLE_MAPPING_DELETED title: Federation Settings Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - GROUP_DELETED - GROUP_CREATED @@ -17333,6 +17454,8 @@ components: - SANDBOX_DISABLED_FOR_ORG title: Org Event Types type: string + x-xgen-IPA-exception: + xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation. - enum: - AWS_SELF_SERVE_ACCOUNT_LINKED - AWS_SELF_SERVE_ACCOUNT_LINK_PENDING @@ -17482,7 +17605,7 @@ components: - metricName type: object ExtraRetentionSetting: - description: extra retention setting item in the desired backup policy. + description: Extra retention setting item in the desired backup policy. properties: frequencyType: description: The frequency type for the extra retention settings for the cluster. @@ -19592,6 +19715,30 @@ components: required: - metricName type: object + GCPAccountDetails: + properties: + cidrBlock: + description: The VPC CIDR Block. + type: string + cloudProvider: + description: Cloud provider. + type: string + gcpProjectId: + description: The GCP Project ID. + type: string + 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. + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: '#/components/schemas/Link' + readOnly: true + type: array + vpcNetworkName: + description: The name of the VPC network. + type: string + type: object GCPCloudProviderContainer: allOf: - $ref: '#/components/schemas/CloudProviderContainer' @@ -19666,8 +19813,6 @@ components: - WESTERN_EUROPE - WESTERN_US type: string - x-xgen-IPA-exception: - xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation type: array type: object description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. @@ -21416,6 +21561,7 @@ components: - SSH_KEY_NDS_HOST_ACCESS_REFRESHED - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT - SSH_KEY_NDS_HOST_ACCESS_GRANTED + - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED - HOST_SSH_SESSION_ENDED - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS - PUSH_BASED_LOG_EXPORT_RESUMED @@ -24160,7 +24306,7 @@ components: title: Cluster Description type: object LegacyAtlasTenantClusterUpgradeRequest: - description: Request containing target state of tenant cluster to be upgraded + description: Request containing target state of tenant cluster to be upgraded. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -25970,7 +26116,7 @@ components: type: array type: object MetricDataPoint: - description: value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. + description: Value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. properties: timestamp: description: Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -25984,7 +26130,7 @@ components: readOnly: true type: object MetricDataPoint_Atlas: - description: value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. + description: Value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. properties: timestamp: description: Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. @@ -26518,6 +26664,7 @@ components: - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED + - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED @@ -26577,6 +26724,18 @@ components: - PUSH_BASED_LOG_EXPORT_ENABLED - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED - PUSH_BASED_LOG_EXPORT_DISABLED + - LOG_STREAMING_ENABLED + - LOG_STREAMING_CONFIGURATION_UPDATED + - LOG_STREAMING_DISABLED + - DATADOG_LOG_STREAMING_ENABLED + - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED + - DATADOG_LOG_STREAMING_DISABLED + - SPLUNK_LOG_STREAMING_ENABLED + - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED + - SPLUNK_LOG_STREAMING_DISABLED + - S3_LOG_STREAMING_ENABLED + - S3_LOG_STREAMING_CONFIGURATION_UPDATED + - S3_LOG_STREAMING_DISABLED - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED - CONTAINER_DELETED - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED @@ -26613,6 +26772,8 @@ components: - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED + - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE + - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE example: CLUSTER_CREATED title: NDS Audit Types type: string @@ -27377,7 +27538,10 @@ components: ***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. - To learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. + Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. + externalDocs: + description: New Relic Plugin EOL Statement + url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267 properties: accountId: description: Unique 40-hexadecimal digit string that identifies your New Relic account. @@ -28856,7 +29020,7 @@ components: readOnly: true type: object OrgServiceAccountRequest: - description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. + description: Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn't create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request. properties: description: description: Human readable description for the Service Account. @@ -29228,6 +29392,8 @@ components: apiAccessListRequired: description: Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization. type: boolean + customSessionTimeouts: + $ref: '#/components/schemas/CustomSessionTimeouts' genAIFeaturesEnabled: default: true description: Flag that indicates whether this organization has access to generative AI features. This setting only applies to Atlas Commercial and is enabled by default. Once this setting is turned on, Project Owners may be able to enable or disable individual AI features at the project level. @@ -31060,8 +31226,8 @@ components: readOnly: true type: object x-xgen-IPA-exception: - xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation. + xgen-IPA-124-array-max-items: Schema predates IPA validation. readOnly: true type: array stats: @@ -31253,7 +31419,7 @@ components: type: array type: object PinnedNamespaces: - description: Pinned namespaces view for cluster + description: Pinned namespaces view for cluster. properties: clusterId: description: Unique 24-hexadecimal digit string that identifies the request cluster. @@ -31759,6 +31925,9 @@ components: queryShapeHash: description: A hexadecimal string that represents the hash of a MongoDB query shape. type: string + systemQuery: + description: Indicates whether this query shape represents a system-initiated query. + type: boolean totalTimeToResponseMicros: description: Time in microseconds spent from the beginning of query processing to the first server response. format: double @@ -32599,7 +32768,7 @@ components: title: Replication Specifications type: object RequestAccepted: - description: Accepted + description: Accepted. type: object ResourceEventTypeView: description: Unique identifier of event type. @@ -36074,6 +36243,14 @@ components: StreamsKafkaAuthentication: description: User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode. properties: + clientId: + description: OIDC client identifier for authentication to the Kafka cluster. This field is not supported yet. + type: string + clientSecret: + description: OIDC client secret for authentication to the Kafka cluster. This field is not supported yet. + format: password + type: string + writeOnly: true 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. externalDocs: @@ -36084,13 +36261,22 @@ components: readOnly: true type: array mechanism: - description: Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512. + description: Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER. + type: string + method: + description: SASL OAUTHBEARER authentication method. Can only be OIDC currently. This field is not supported yet. type: string password: description: Password of the account to connect to the Kafka cluster. format: password type: string writeOnly: true + saslOauthbearerExtensions: + description: SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration. This field is not supported yet. + type: string + scope: + description: OIDC scope parameter defining the access permissions requested. This field is not supported yet. + type: string sslCertificate: description: SSL certificate for client authentication to Kafka. type: string @@ -36102,6 +36288,9 @@ components: description: Password for the SSL key, if it is password protected. type: string writeOnly: true + tokenEndpointUrl: + description: OIDC token endpoint URL for obtaining access tokens. This field is not supported yet. + type: string username: description: Username of the account to connect to the Kafka cluster. type: string @@ -36166,10 +36355,6 @@ components: name: description: Reserved. Will be used by PRIVATE_LINK connection type. type: string - tgwId: - description: Reserved. Will be used by TRANSIT_GATEWAY connection type. - pattern: ^(tgw-)[0-9a-zA-Z]+$ - type: string tgwRouteId: description: Reserved. Will be used by TRANSIT_GATEWAY connection type. example: 32b6e34b3d91647abb20e7b8 @@ -36184,9 +36369,6 @@ components: - TRANSIT_GATEWAY title: Networking Access Type type: string - vpcCIDR: - description: Reserved. Will be used by TRANSIT_GATEWAY connection type. - type: string type: object StreamsKafkaSecurity: description: Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. @@ -36242,7 +36424,7 @@ components: title: Streams Matcher Fields type: string StreamsModifyStreamProcessor: - description: A request to modify an existing stream processor + description: A request to modify an existing stream processor. 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. @@ -36333,6 +36515,13 @@ components: description: Error message if the state is FAILED. readOnly: true type: string + gcpServiceAttachmentUris: + description: Service Attachment URIs of each availability zone for the GCP Confluent cluster. + items: + type: string + maxItems: 3 + type: array + uniqueItems: true interfaceEndpointId: description: Interface endpoint ID that is created from the service endpoint ID provided. readOnly: true @@ -36505,7 +36694,7 @@ components: type: boolean type: object StreamsStartStreamProcessorWith: - description: A request to start a stream processor + description: A request to start a stream processor. 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. @@ -37402,7 +37591,7 @@ components: definition: $ref: '#/components/schemas/TextSearchIndexDefinition' type: object - description: Text Search Index Create Request + description: Text Search Index Create Request. required: - collectionName - database @@ -38904,7 +39093,7 @@ components: definition: $ref: '#/components/schemas/VectorSearchIndexDefinition' type: object - description: Vector Search Index Create Request + description: Vector Search Index Create Request. required: - collectionName - database @@ -39852,7 +40041,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 71ac9e4b796c59607af25b073aa510451ae85fdb + x-xgen-sha: 6d1feb3f4a77896c6eda8ce3e744affc6a1f024c openapi: 3.0.1 paths: /api/atlas/v2: @@ -39880,14 +40069,17 @@ paths: $ref: '#/components/responses/forbidden' "500": $ref: '#/components/responses/internalServerError' - summary: Return the status of this MongoDB application + summary: Return the Status of This MongoDB Application tags: - Root x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus + x-xgen-method-verb-override: + customMethod: false + verb: getSystemStatus /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. - operationId: listAlertConfigurationMatchersFieldNames + operationId: listAlertConfigMatcherFieldNames parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -39900,7 +40092,7 @@ paths: $ref: '#/components/schemas/MatcherFieldView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -39912,11 +40104,12 @@ paths: summary: Return All Alert Configuration Matchers Field Names tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigMatcherFieldNames + x-xgen-operation-id-override: listMatcherFieldNames /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. - operationId: listClustersForAllProjects + operationId: listClusterDetails parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -39940,7 +40133,10 @@ paths: summary: Return All Authorized Clusters in All Projects tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusterDetails + x-xgen-method-verb-override: + customMethod: false + verb: listDetails /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -39972,7 +40168,7 @@ paths: /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' - operationId: deleteFederationApp + operationId: deleteFederationSetting parameters: - $ref: '#/components/parameters/federationSettingsId' responses: @@ -39994,11 +40190,11 @@ paths: summary: Delete One Federation Settings Instance tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSetting /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. - operationId: listConnectedOrgConfigs + operationId: listFederationSettingConnectedOrgConfigs parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40025,11 +40221,12 @@ paths: summary: Return All Organization Configurations from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigs + x-xgen-operation-id-override: listConnectedOrgConfigs /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' - operationId: removeConnectedOrgConfig + operationId: removeFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40060,13 +40257,14 @@ paths: summary: Remove One Organization Configuration from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeFederationSettingConnectedOrgConfig x-xgen-method-verb-override: customMethod: "True" verb: remove + x-xgen-operation-id-override: removeConnectedOrgConfig get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. - operationId: getConnectedOrgConfig + operationId: getFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40085,7 +40283,7 @@ paths: schema: $ref: '#/components/schemas/ConnectedOrgConfig' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40101,10 +40299,11 @@ paths: summary: Return One Organization Configuration from One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfig + x-xgen-operation-id-override: getConnectedOrgConfig patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected." - operationId: updateConnectedOrgConfig + operationId: updateFederationSettingConnectedOrgConfig parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40144,11 +40343,12 @@ paths: summary: Update One Organization Configuration in One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfig + x-xgen-operation-id-override: updateConnectedOrgConfig /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: listRoleMappings + operationId: listFederationSettingConnectedOrgConfigRoleMappings parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40174,10 +40374,11 @@ paths: summary: Return All Role Mappings from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigRoleMappings + x-xgen-operation-id-override: listRoleMappings post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: createRoleMapping + operationId: createFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40210,11 +40411,12 @@ paths: summary: Create One Role Mapping in One Organization Configuration tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: createRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: deleteRoleMapping + operationId: deleteFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. @@ -40246,10 +40448,11 @@ paths: summary: Remove One Role Mapping from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: deleteRoleMapping get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: getRoleMapping + operationId: getFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. @@ -40269,7 +40472,7 @@ paths: schema: $ref: '#/components/schemas/AuthFederationRoleMapping' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40285,10 +40488,11 @@ paths: summary: Return One Role Mapping from One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: getRoleMapping put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateRoleMapping + operationId: updateFederationSettingConnectedOrgConfigRoleMapping parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. @@ -40329,11 +40533,12 @@ paths: summary: Update One Role Mapping in One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfigRoleMapping + x-xgen-operation-id-override: updateRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: listIdentityProviders + operationId: listFederationSettingIdentityProviders parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40368,7 +40573,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedFederationIdentityProvider' x-xgen-IPA-exception: - xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation + xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40384,13 +40589,14 @@ paths: summary: Return All Identity Providers in One Federation tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingIdentityProviders + x-xgen-operation-id-override: listIdentityProviders post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. **Note**: This resource only supports the creation of OIDC identity providers. - operationId: createIdentityProvider + operationId: createFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/envelope' @@ -40422,14 +40628,15 @@ paths: summary: Create One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingIdentityProvider + x-xgen-operation-id-override: createIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider." externalDocs: description: Manage Organization Mapping for Federated Authentication url: https://www.mongodb.com/docs/atlas/security/manage-org-mapping/ - operationId: deleteIdentityProvider + operationId: deleteFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the identity provider to connect. @@ -40459,10 +40666,11 @@ paths: summary: Delete One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingIdentityProvider + x-xgen-operation-id-override: deleteIdentityProvider get: description: Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: getIdentityProvider + operationId: getFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. @@ -40481,13 +40689,13 @@ paths: $ref: '#/components/schemas/FederationSamlIdentityProvider' x-sunset: "2025-01-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-11-15+json: schema: $ref: '#/components/schemas/FederationIdentityProvider' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-11-15" description: OK "400": @@ -40503,13 +40711,14 @@ paths: summary: Return One Identity Provider by ID tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProvider + x-xgen-operation-id-override: getIdentityProvider patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. **Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. - operationId: updateIdentityProvider + operationId: updateFederationSettingIdentityProvider parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. @@ -40556,14 +40765,15 @@ paths: summary: Update One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingIdentityProvider + x-xgen-operation-id-override: updateIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected." externalDocs: description: Configure OIDC Authorization url: https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks - operationId: revokeJwksFromIdentityProvider + operationId: revokeFederationSettingIdentityProviderJwks parameters: - $ref: '#/components/parameters/federationSettingsId' - description: Unique 24-hexadecimal digit string that identifies the identity provider to connect. @@ -40593,14 +40803,15 @@ paths: summary: Revoke JWKS from One OIDC Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeFederationSettingIdentityProviderJwks x-xgen-method-verb-override: customMethod: "True" verb: revoke + x-xgen-operation-id-override: revokeIdentityProviderJwks /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. - operationId: getIdentityProviderMetadata + operationId: getFederationSettingIdentityProviderMetadata parameters: - $ref: '#/components/parameters/federationSettingsId' - $ref: '#/components/parameters/identityProviderId' @@ -40625,14 +40836,15 @@ paths: summary: Return Metadata of One Identity Provider tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProviderMetadata x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getIdentityProviderMetadata /api/atlas/v2/groups: get: description: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. - operationId: listProjects + operationId: listGroups parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -40660,10 +40872,10 @@ paths: summary: Return All Projects tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroups post: description: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. - operationId: createProject + operationId: createGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -40703,11 +40915,11 @@ paths: summary: Create One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroup /api/atlas/v2/groups/{groupId}: delete: description: Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProject + operationId: deleteGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40733,10 +40945,10 @@ paths: summary: Remove One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroup get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProject + operationId: getGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40748,8 +40960,7 @@ paths: schema: $ref: '#/components/schemas/Group' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -40765,10 +40976,10 @@ paths: summary: Return One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroup patch: description: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProject + operationId: updateGroup parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40801,12 +41012,12 @@ paths: summary: Update One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroup /api/atlas/v2/groups/{groupId}/access: post: deprecated: true description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - operationId: addUserToProject + operationId: addGroupAccessUser parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' @@ -40843,17 +41054,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addGroupAccessUser x-xgen-method-verb-override: customMethod: "True" verb: addUser + x-xgen-operation-id-override: addGroupUser /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: listProjectIpAccessLists + operationId: listGroupAccessListEntries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40882,13 +41094,17 @@ paths: - Project IP Access List x-xgen-changelog: "2025-05-08": Corrects an issue where the endpoint would include Atlas internal entries. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listGroupAccessListEntries + x-xgen-method-verb-override: + customMethod: false + verb: listEntries + x-xgen-operation-id-override: listAccessListEntries post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: createProjectIpAccessList + operationId: createGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40926,14 +41142,18 @@ paths: summary: Add Entries to Project IP Access List tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: createEntry + x-xgen-operation-id-override: createAccessListEntry /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: deleteProjectIpAccessList + operationId: deleteGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40968,13 +41188,17 @@ paths: summary: Remove One Entry from One Project IP Access List tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: deleteEntry + x-xgen-operation-id-override: deleteAccessListEntry get: description: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (`/groups/{GROUP-ID}/accessList`) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (`/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`) manages those access lists. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list - operationId: getProjectIpList + operationId: getGroupAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -40994,7 +41218,7 @@ paths: schema: $ref: '#/components/schemas/NetworkPermissionEntry' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41008,11 +41232,15 @@ paths: summary: Return One Project IP Access List Entry tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: getEntry + x-xgen-operation-id-override: getAccessListEntry /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. - operationId: getProjectIpAccessListStatus + operationId: getGroupAccessListStatus parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41032,7 +41260,7 @@ paths: schema: $ref: '#/components/schemas/NetworkPermissionEntryStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -41048,14 +41276,15 @@ paths: summary: Return Status of One Project IP Access List Entry tags: - Project IP Access List - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListStatus + x-xgen-operation-id-override: getAccessListStatus /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listAlertConfigurations + operationId: listGroupAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41082,13 +41311,14 @@ paths: summary: Return All Alert Configurations in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listGroupAlertConfigs + x-xgen-operation-id-override: listAlertConfigs post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. - operationId: createAlertConfiguration + operationId: createGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41121,7 +41351,8 @@ paths: summary: Create One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createGroupAlertConfig + x-xgen-operation-id-override: createAlertConfig /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -41131,7 +41362,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: deleteAlertConfiguration + operationId: deleteGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41161,7 +41392,8 @@ paths: summary: Remove One Alert Configuration from One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteGroupAlertConfig + x-xgen-operation-id-override: deleteAlertConfig get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. @@ -41170,7 +41402,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: getAlertConfiguration + operationId: getGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41190,7 +41422,7 @@ paths: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41204,7 +41436,8 @@ paths: summary: Return One Alert Configuration from One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertConfig + x-xgen-operation-id-override: getAlertConfig patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41215,7 +41448,7 @@ paths: externalDocs: description: Update One Alert Configuration url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration - operationId: toggleAlertConfiguration + operationId: toggleGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41254,10 +41487,11 @@ paths: summary: Toggle State of One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleGroupAlertConfig x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: toggle + x-xgen-operation-id-override: toggleAlertConfig put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41268,7 +41502,7 @@ paths: externalDocs: description: Toggle One State of One Alert Configuration in One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration - operationId: updateAlertConfiguration + operationId: updateGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41309,7 +41543,8 @@ paths: summary: Update One Alert Configuration in One Project tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateGroupAlertConfig + x-xgen-operation-id-override: updateAlertConfig /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -41319,7 +41554,7 @@ paths: externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations - operationId: listAlertsByAlertConfigurationId + operationId: getGroupAlertConfigAlerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41342,8 +41577,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAlertView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41357,14 +41592,15 @@ paths: summary: Return All Open Alerts for One Alert Configuration tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlertConfigAlerts + x-xgen-operation-id-override: getAlertConfigAlerts /api/atlas/v2/groups/{groupId}/alerts: get: description: |- Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listAlerts + operationId: listGroupAlerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41402,7 +41638,8 @@ paths: summary: Return All Alerts from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listGroupAlerts + x-xgen-operation-id-override: listAlerts /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -41412,7 +41649,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: getAlert + operationId: getGroupAlert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41431,7 +41668,7 @@ paths: schema: $ref: '#/components/schemas/AlertViewForNdsGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41445,7 +41682,8 @@ paths: summary: Return One Alert from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlert + x-xgen-operation-id-override: getAlert patch: description: |- Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. @@ -41454,7 +41692,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: acknowledgeAlert + operationId: acknowledgeGroupAlert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41502,10 +41740,11 @@ paths: summary: Acknowledge One Alert from One Project tags: - Alerts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeGroupAlert x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: acknowledge + x-xgen-operation-id-override: acknowledgeAlert /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -41515,7 +41754,7 @@ paths: externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts - operationId: listAlertConfigurationsByAlertId + operationId: getGroupAlertAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41537,8 +41776,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAlertConfigView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41552,14 +41791,15 @@ paths: summary: Return All Alert Configurations Set for One Alert tags: - Alert Configurations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertAlertConfigs + x-xgen-operation-id-override: getAlertConfigs /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: listProjectApiKeys + operationId: listGroupApiKeys parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41586,10 +41826,10 @@ paths: summary: Return All Organization API Keys Assigned to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listGroupApiKeys post: description: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createProjectApiKey + operationId: createGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41620,14 +41860,14 @@ paths: summary: Create and Assign One Organization API Key to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createGroupApiKey /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: removeProjectApiKey + operationId: removeGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41658,13 +41898,13 @@ paths: summary: Unassign One Organization API Key from One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeGroupApiKey x-xgen-method-verb-override: customMethod: "True" verb: remove patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. - operationId: updateApiKeyRoles + operationId: updateGroupApiKeyRoles parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pageNum' @@ -41707,13 +41947,14 @@ paths: summary: Update Organization API Key Roles for One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateGroupApiKeyRoles x-xgen-method-verb-override: customMethod: "True" verb: updateRoles + x-xgen-operation-id-override: updateApiKeyRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: addProjectApiKey + operationId: addGroupApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41751,14 +41992,14 @@ paths: summary: Assign One Organization API Key to One Project tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addGroupApiKey x-xgen-method-verb-override: customMethod: "True" verb: add /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. - operationId: getAuditingConfiguration + operationId: getGroupAuditLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41770,7 +42011,7 @@ paths: schema: $ref: '#/components/schemas/AuditLog' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41784,10 +42025,10 @@ paths: summary: Return Auditing Configuration for One Project tags: - Auditing - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getGroupAuditLog patch: description: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. - operationId: updateAuditingConfiguration + operationId: updateGroupAuditLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41820,11 +42061,12 @@ paths: summary: Update Auditing Configuration for One Project tags: - Auditing - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateGroupAuditLog + x-xgen-operation-id-override: updateAuditLog /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getAwsCustomDns + operationId: getGroupAwsCustomDns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41836,7 +42078,7 @@ paths: schema: $ref: '#/components/schemas/AWSCustomDNSEnabledView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -41850,10 +42092,11 @@ paths: summary: Return One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getGroupAwsCustomDns + x-xgen-operation-id-override: getAwsCustomDns patch: description: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: toggleAwsCustomDns + operationId: toggleGroupAwsCustomDns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41884,14 +42127,15 @@ paths: summary: Update State of One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleGroupAwsCustomDns x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleAwsCustomDns /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listExportBuckets + operationId: listGroupBackupExportBuckets parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41923,10 +42167,11 @@ paths: summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupExportBuckets + x-xgen-operation-id-override: listExportBuckets post: description: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createExportBucket + operationId: createGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -41941,6 +42186,7 @@ paths: bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 + requirePrivateNetworking: false schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketRequest' x-xgen-version: "2023-01-01" @@ -41952,6 +42198,7 @@ paths: bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 + requirePrivateNetworking: false Azure: description: Azure value: @@ -41986,6 +42233,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42003,6 +42251,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true Azure: description: Azure value: @@ -42042,11 +42291,12 @@ paths: summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupExportBucket + x-xgen-operation-id-override: createExportBucket /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteExportBucket + operationId: deleteGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42077,10 +42327,11 @@ paths: summary: Delete One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupExportBucket + x-xgen-operation-id-override: deleteExportBucket get: description: Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getExportBucket + operationId: getGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42108,6 +42359,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42125,6 +42377,7 @@ paths: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 + requirePrivateNetworking: true Azure: description: Azure value: @@ -42162,11 +42415,12 @@ paths: summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupExportBucket + x-xgen-operation-id-override: getExportBucket /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: delete: description: Disables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: disableDataProtectionSettings + operationId: disableGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42190,13 +42444,14 @@ paths: summary: Disable Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableGroupBackupCompliancePolicy x-xgen-method-verb-override: customMethod: "True" verb: disable + x-xgen-operation-id-override: disableCompliancePolicy get: description: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getDataProtectionSettings + operationId: getGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42209,13 +42464,13 @@ paths: $ref: '#/components/schemas/DataProtectionSettings' x-sunset: "2026-10-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-10-01+json: schema: $ref: '#/components/schemas/DataProtectionSettings20231001' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-10-01" description: OK "401": @@ -42229,10 +42484,11 @@ paths: summary: Return Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupCompliancePolicy + x-xgen-operation-id-override: getCompliancePolicy put: description: Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateDataProtectionSettings + operationId: updateGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42281,11 +42537,12 @@ paths: summary: Update Backup Compliance Policy Settings tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupCompliancePolicy + x-xgen-operation-id-override: updateCompliancePolicy /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listCloudProviderAccessRoles + operationId: listGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42297,9 +42554,9 @@ paths: schema: $ref: '#/components/schemas/CloudProviderAccessRoles' x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -42313,13 +42570,14 @@ paths: summary: Return All Cloud Provider Access Roles tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listGroupCloudProviderAccess + x-xgen-operation-id-override: listCloudProviderAccess post: description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status `IN_PROGRESS` will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ - operationId: createCloudProviderAccessRole + operationId: createGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42350,11 +42608,12 @@ paths: summary: Create One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createGroupCloudProviderAccess + x-xgen-operation-id-override: createCloudProviderAccess /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deauthorizeCloudProviderAccessRole + operationId: deauthorizeGroupCloudProviderAccessRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42395,14 +42654,15 @@ paths: summary: Deauthorize One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeGroupCloudProviderAccessRole x-xgen-method-verb-override: customMethod: "True" verb: deauthorizeRole + x-xgen-operation-id-override: deauthorizeProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getCloudProviderAccessRole + operationId: getGroupCloudProviderAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42421,7 +42681,7 @@ paths: schema: $ref: '#/components/schemas/CloudProviderAccessRole' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -42435,13 +42695,14 @@ paths: summary: Return One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getGroupCloudProviderAccess + x-xgen-operation-id-override: getCloudProviderAccess patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ - operationId: authorizeCloudProviderAccessRole + operationId: authorizeGroupCloudProviderAccessRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42483,10 +42744,11 @@ paths: summary: Authorize One Cloud Provider Access Role tags: - Cloud Provider Access - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeGroupCloudProviderAccessRole x-xgen-method-verb-override: customMethod: "True" verb: authorizeRole + x-xgen-operation-id-override: authorizeProviderAccessRole /api/atlas/v2/groups/{groupId}/clusters: get: description: |- @@ -42496,7 +42758,7 @@ paths: externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters - operationId: listClusters + operationId: listGroupClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42539,7 +42801,8 @@ paths: summary: Return All Clusters in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusters + x-xgen-operation-id-override: listClusters post: description: |- Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. @@ -42548,7 +42811,7 @@ paths: externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster - operationId: createCluster + operationId: createGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42763,7 +43026,8 @@ paths: - Clusters x-xgen-changelog: "2025-06-05": Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createGroupCluster + x-xgen-operation-id-override: createCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: description: |- @@ -42773,7 +43037,7 @@ paths: externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster - operationId: deleteCluster + operationId: deleteGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -42814,7 +43078,8 @@ paths: summary: Remove One Cluster from One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteGroupCluster + x-xgen-operation-id-override: deleteCluster get: 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. @@ -42823,7 +43088,7 @@ paths: externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster - operationId: getCluster + operationId: getGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -42843,20 +43108,20 @@ paths: $ref: '#/components/schemas/LegacyAtlasCluster' x-sunset: "2026-11-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-02-01+json: schema: $ref: '#/components/schemas/AdvancedClusterDescription' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -42872,10 +43137,11 @@ paths: summary: Return One Cluster from One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupCluster + x-xgen-operation-id-override: getCluster patch: description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster''s termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can''t modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters.' - operationId: updateCluster + operationId: updateGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -42945,11 +43211,12 @@ paths: - Clusters x-xgen-changelog: "2025-06-05": Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupCluster + x-xgen-operation-id-override: updateCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. - operationId: getCollStatsLatencyNamespaceClusterMeasurements + operationId: listGroupClusterCollStatMeasurements parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster to retrieve metrics for. @@ -43032,11 +43299,12 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatMeasurements + x-xgen-operation-id-override: listCollStatMeasurements /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. - operationId: getCollStatsLatencyNamespacesForCluster + operationId: getGroupClusterCollStatNamespaces parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster to pin namespaces to. @@ -43076,18 +43344,19 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Ranked Namespaces from a Cluster + summary: Return Ranked Namespaces from One Cluster tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupClusterCollStatNamespaces x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getClusterNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: deprecated: true description: Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. - operationId: autoScalingConfiguration + operationId: autoGroupClusterScalingConfiguration parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43106,7 +43375,7 @@ paths: schema: $ref: '#/components/schemas/ClusterDescriptionAutoScalingModeConfiguration' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -43122,13 +43391,14 @@ paths: summary: Return Auto Scaling Configuration for One Sharded Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoGroupClusterScalingConfiguration x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: autoScalingConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: listBackupExportJobs + operationId: listGroupClusterBackupExports parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43162,10 +43432,11 @@ paths: summary: Return All Snapshot Export Jobs tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupExports + x-xgen-operation-id-override: listBackupExports post: description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: createBackupExportJob + operationId: createGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43206,11 +43477,12 @@ paths: summary: Create One Snapshot Export Job tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupExport + x-xgen-operation-id-override: createBackupExport /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: getBackupExportJob + operationId: getGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43248,11 +43520,12 @@ paths: summary: Return One Snapshot Export Job tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupExport + x-xgen-operation-id-override: getBackupExport /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: listBackupRestoreJobs + operationId: listGroupClusterBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43286,13 +43559,14 @@ paths: summary: Return All Restore Jobs for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupRestoreJobs + x-xgen-operation-id-override: listBackupRestoreJobs post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: createBackupRestoreJob + operationId: createGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43331,14 +43605,15 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Cluster + summary: Create One Restore Job of One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupRestoreJob + x-xgen-operation-id-override: createBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: cancelBackupRestoreJob + operationId: cancelGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43378,13 +43653,14 @@ paths: summary: Cancel One Restore Job for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelGroupClusterBackupRestoreJob x-xgen-method-verb-override: customMethod: "True" verb: cancel + x-xgen-operation-id-override: cancelBackupRestoreJob get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: getBackupRestoreJob + operationId: getGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43422,11 +43698,12 @@ paths: summary: Return One Restore Job for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupRestoreJob + x-xgen-operation-id-override: getBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: description: Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. - operationId: deleteAllBackupSchedules + operationId: deleteGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43463,10 +43740,11 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSchedule + x-xgen-operation-id-override: deleteClusterBackupSchedule get: description: Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getBackupSchedule + operationId: getGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43502,13 +43780,14 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSchedule x-xgen-method-verb-override: customMethod: "False" verb: get + x-xgen-operation-id-override: getBackupSchedule patch: description: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateBackupSchedule + operationId: updateGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43559,11 +43838,12 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSchedule + x-xgen-operation-id-override: updateBackupSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: listReplicaSetBackups + operationId: listGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43599,13 +43879,14 @@ paths: summary: Return All Replica Set Cloud Backups tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshots + x-xgen-operation-id-override: listBackupSnapshots post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: takeSnapshot + operationId: takeGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -43645,14 +43926,15 @@ paths: summary: Take One On-Demand Snapshot tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeGroupClusterBackupSnapshots x-xgen-method-verb-override: customMethod: "True" verb: take + x-xgen-operation-id-override: takeSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteReplicaSetBackup + operationId: deleteGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43690,10 +43972,11 @@ paths: summary: Remove One Replica Set Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshot + x-xgen-operation-id-override: deleteClusterBackupSnapshot get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: getReplicaSetBackup + operationId: getGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43719,7 +44002,7 @@ paths: schema: $ref: '#/components/schemas/DiskBackupReplicaSet' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -43735,10 +44018,11 @@ paths: summary: Return One Replica Set Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshot + x-xgen-operation-id-override: getClusterBackupSnapshot patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: updateSnapshotRetention + operationId: updateGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43785,11 +44069,12 @@ paths: summary: Update Expiration Date for One Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSnapshot + x-xgen-operation-id-override: updateBackupSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. - operationId: deleteShardedClusterBackup + operationId: deleteGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43825,10 +44110,11 @@ paths: summary: Remove One Sharded Cluster Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshotShardedCluster + x-xgen-operation-id-override: deleteBackupShardedCluster get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: getShardedClusterBackup + operationId: getGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43854,7 +44140,7 @@ paths: schema: $ref: '#/components/schemas/DiskBackupShardedClusterSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -43870,11 +44156,12 @@ paths: summary: Return One Sharded Cluster Cloud Backup tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshotShardedCluster + x-xgen-operation-id-override: getBackupShardedCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. - operationId: listShardedClusterBackups + operationId: listGroupClusterBackupSnapshotShardedClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -43907,7 +44194,8 @@ paths: summary: Return All Sharded Cluster Cloud Backups tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshotShardedClusters + x-xgen-operation-id-override: listBackupShardedClusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: deprecated: true @@ -43918,7 +44206,7 @@ paths: externalDocs: description: downloadFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup - operationId: downloadSharedClusterBackup + operationId: downloadGroupClusterBackupTenant parameters: - description: Human-readable label that identifies the cluster. in: path @@ -43961,9 +44249,10 @@ paths: summary: Download One M2 or M5 Cluster Snapshot tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadGroupClusterBackupTenant x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: downloadClusterBackupTenant /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: deprecated: true @@ -43974,7 +44263,7 @@ paths: externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob - operationId: createSharedClusterBackupRestoreJob + operationId: createGroupClusterBackupTenantRestore parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44017,7 +44306,8 @@ paths: summary: Create One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createGroupClusterBackupTenantRestore + x-xgen-operation-id-override: createBackupTenantRestore /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: deprecated: true @@ -44028,7 +44318,7 @@ paths: externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs - operationId: listSharedClusterBackupRestoreJobs + operationId: listGroupClusterBackupTenantRestores parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44062,7 +44352,8 @@ paths: summary: Return All Restore Jobs for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listGroupClusterBackupTenantRestores + x-xgen-operation-id-override: listBackupTenantRestores /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: deprecated: true @@ -44073,7 +44364,7 @@ paths: externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob - operationId: getSharedClusterBackupRestoreJob + operationId: getGroupClusterBackupTenantRestore parameters: - description: Human-readable label that identifies the cluster. in: path @@ -44114,7 +44405,8 @@ paths: summary: Return One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getGroupClusterBackupTenantRestore + x-xgen-operation-id-override: getBackupTenantRestore /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: deprecated: true @@ -44125,7 +44417,7 @@ paths: externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups - operationId: listSharedClusterBackups + operationId: listGroupClusterBackupTenantSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44159,7 +44451,8 @@ paths: summary: Return All Snapshots for One M2 or M5 Cluster tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listGroupClusterBackupTenantSnapshots + x-xgen-operation-id-override: listClusterBackupSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: deprecated: true @@ -44170,7 +44463,7 @@ paths: externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup - operationId: getSharedClusterBackup + operationId: getGroupClusterBackupTenantSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44211,12 +44504,13 @@ paths: summary: Return One Snapshot of One M2 or M5 Cluster tags: - Shared-Tier Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getGroupClusterBackupTenantSnapshot + x-xgen-operation-id-override: getBackupTenantSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true description: Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listLegacyBackupCheckpoints + operationId: listGroupClusterBackupCheckpoints parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44250,12 +44544,13 @@ paths: summary: Return All Legacy Backup Checkpoints tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterBackupCheckpoints + x-xgen-operation-id-override: listClusterBackupCheckpoints /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true description: Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getLegacyBackupCheckpoint + operationId: getGroupClusterBackupCheckpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44281,7 +44576,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasCheckpointView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -44297,11 +44592,12 @@ paths: summary: Return One Legacy Backup Checkpoint tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterBackupCheckpoint + x-xgen-operation-id-override: getClusterBackupCheckpoint /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. - operationId: getPinnedNamespaces + operationId: listGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44333,13 +44629,14 @@ paths: summary: Return Pinned Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: listNamespaces + x-xgen-operation-id-override: listPinnedNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. - operationId: pinNamespacesPatch + operationId: updateGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44385,13 +44682,14 @@ paths: summary: Add Pinned Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/updateGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: customMethod: "True" verb: updateNamespaces + x-xgen-operation-id-override: updatePinnedNamespaces put: description: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. - operationId: pinNamespacesPut + operationId: pinGroupClusterCollStatPinnedNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44437,14 +44735,15 @@ paths: summary: Pin Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinGroupClusterCollStatPinnedNamespaces x-xgen-method-verb-override: customMethod: "True" verb: pinNamespaces + x-xgen-operation-id-override: pinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - operationId: unpinNamespaces + operationId: unpinGroupClusterCollStatUnpinNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -44480,13 +44779,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Unpin namespaces + summary: Unpin Namespaces tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinGroupClusterCollStatUnpinNamespaces x-xgen-method-verb-override: customMethod: "True" verb: unpinNamespaces + x-xgen-operation-id-override: unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -44494,7 +44794,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: createAtlasSearchIndexDeprecated + operationId: createGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44537,7 +44837,8 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterFtsIndex + x-xgen-operation-id-override: createClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: deprecated: true @@ -44545,7 +44846,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexesDeprecated + operationId: listGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44578,7 +44879,7 @@ paths: $ref: '#/components/schemas/ClusterSearchIndex' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-11-30" x-xgen-version: "2023-01-01" description: OK @@ -44593,7 +44894,11 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterFtsIndex + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: deprecated: true @@ -44601,7 +44906,7 @@ paths: externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndexDeprecated + operationId: deleteGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44642,14 +44947,15 @@ paths: summary: Remove One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterFtsIndex + x-xgen-operation-id-override: deleteClusterFtsIndex get: deprecated: true description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndexDeprecated + operationId: getGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44690,14 +44996,15 @@ paths: summary: Return One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterFtsIndex + x-xgen-operation-id-override: getClusterFtsIndex patch: deprecated: true description: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndexDeprecated + operationId: updateGroupClusterFtsIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -44749,14 +45056,15 @@ paths: summary: Update One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterFtsIndex + x-xgen-operation-id-override: updateClusterFtsIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: description: Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: getManagedNamespace + operationId: getGroupClusterGlobalWrites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -44776,20 +45084,20 @@ paths: $ref: '#/components/schemas/GeoSharding' x-sunset: "2026-11-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2023-02-01+json: schema: $ref: '#/components/schemas/GeoSharding' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/GeoSharding20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -44803,14 +45111,15 @@ paths: summary: Return One Managed Namespace in One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getGroupClusterGlobalWrites + x-xgen-operation-id-override: getClusterGlobalWrites /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: description: Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: deleteAllCustomZoneMappings + operationId: deleteGroupClusterGlobalWriteCustomZoneMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -44851,13 +45160,14 @@ paths: summary: Remove All Custom Zone Mappings from One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteCustomZoneMapping + x-xgen-operation-id-override: deleteCustomZoneMapping post: description: Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: createCustomZoneMapping + operationId: createGroupClusterGlobalWriteCustomZoneMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -44914,14 +45224,15 @@ paths: summary: Add One Custom Zone Mapping to One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteCustomZoneMapping + x-xgen-operation-id-override: createCustomZoneMapping /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: description: Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: deleteManagedNamespace + operationId: deleteGroupClusterGlobalWriteManagedNamespaces parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -44974,13 +45285,14 @@ paths: summary: Remove One Managed Namespace from One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteManagedNamespaces + x-xgen-operation-id-override: deleteManagedNamespaces post: description: Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: createManagedNamespace + operationId: createGroupClusterGlobalWriteManagedNamespace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45039,14 +45351,15 @@ paths: summary: Create One Managed Namespace in One Global Cluster tags: - Global Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteManagedNamespace + x-xgen-operation-id-override: createManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: description: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Rolling Index Builds on Replica Sets url: https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/ - operationId: createRollingIndex + operationId: createGroupClusterIndexRollingIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45151,14 +45464,18 @@ paths: summary: Create One Rolling Index tags: - Rolling Index - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createGroupClusterIndexRollingIndex + x-xgen-method-verb-override: + customMethod: false + verb: createRollingIndex + x-xgen-operation-id-override: createRollingIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: listOnlineArchives + operationId: listGroupClusterOnlineArchives parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45192,13 +45509,14 @@ paths: summary: Return All Online Archives for One Cluster tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listGroupClusterOnlineArchives + x-xgen-operation-id-override: listOnlineArchives post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: createOnlineArchive + operationId: createGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45242,14 +45560,15 @@ paths: - Online Archive x-xgen-changelog: "2023-08-02": If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createGroupClusterOnlineArchive + x-xgen-operation-id-override: createOnlineArchive /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: deleteOnlineArchive + operationId: deleteGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -45285,13 +45604,14 @@ paths: summary: Remove One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteGroupClusterOnlineArchive + x-xgen-operation-id-override: deleteOnlineArchive get: description: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: getOnlineArchive + operationId: getGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45317,7 +45637,7 @@ paths: schema: $ref: '#/components/schemas/BackupOnlineArchive' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -45333,13 +45653,14 @@ paths: summary: Return One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getGroupClusterOnlineArchive + x-xgen-operation-id-override: getOnlineArchive patch: description: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: updateOnlineArchive + operationId: updateGroupClusterOnlineArchive parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45388,14 +45709,15 @@ paths: summary: Update One Online Archive tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateGroupClusterOnlineArchive + x-xgen-operation-id-override: updateOnlineArchive /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive - operationId: downloadOnlineArchiveQueryLogs + operationId: downloadGroupClusterOnlineArchiveQueryLogs parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -45455,17 +45777,18 @@ paths: summary: Download Online Archive Query Logs tags: - Online Archive - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadGroupClusterOnlineArchiveQueryLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadQueryLogs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: endOutageSimulation + operationId: endGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45498,16 +45821,17 @@ paths: summary: End One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endGroupClusterOutageSimulation x-xgen-method-verb-override: customMethod: "True" verb: end + x-xgen-operation-id-override: endOutageSimulation get: description: Returns one outage simulation for one cluster. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: getOutageSimulation + operationId: getGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45544,16 +45868,17 @@ paths: summary: Return One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getGroupClusterOutageSimulation x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getOutageSimulation post: description: Starts a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage - operationId: startOutageSimulation + operationId: startGroupClusterOutageSimulation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -45593,14 +45918,15 @@ paths: summary: Start One Outage Simulation tags: - Cluster Outage Simulation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startGroupClusterOutageSimulation x-xgen-method-verb-override: customMethod: "True" verb: start + x-xgen-operation-id-override: startOutageSimulation /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions: get: description: Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDropIndexes + operationId: listGroupClusterPerformanceAdvisorDropIndexSuggestions parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -45633,11 +45959,12 @@ paths: summary: Return All Suggested Indexes to Drop tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorDropIndexSuggestions + x-xgen-operation-id-override: listDropIndexSuggestions /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice: get: description: Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSchemaAdvice + operationId: listGroupClusterPerformanceAdvisorSchemaAdvice parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -45670,11 +45997,12 @@ paths: summary: Return Schema Advice tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSchemaAdvice + x-xgen-operation-id-override: listSchemaAdvice /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listClusterSuggestedIndexes + operationId: listGroupClusterPerformanceAdvisorSuggestedIndexes parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -45750,14 +46078,15 @@ paths: summary: Return All Suggested Indexes tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSuggestedIndexes + x-xgen-operation-id-override: listClusterSuggestedIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: getClusterAdvancedConfiguration + operationId: getGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45777,13 +46106,13 @@ paths: $ref: '#/components/schemas/ClusterDescriptionProcessArgs' x-sunset: "2026-03-01" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionProcessArgs20240805' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -45799,13 +46128,14 @@ paths: summary: Return Advanced Configuration Options for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterProcessArgs + x-xgen-operation-id-override: getProcessArgs patch: description: Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ - operationId: updateClusterAdvancedConfiguration + operationId: updateGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -45855,7 +46185,8 @@ paths: summary: Update Advanced Configuration Options for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupClusterProcessArgs + x-xgen-operation-id-override: updateProcessArgs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details: get: description: Returns the metadata and statistics summary for a given query shape hash. @@ -45938,10 +46269,11 @@ paths: tags: - Query Shape Insights x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightDetails + x-xgen-operation-id-override: getQueryShapeDetails /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 + operationId: listGroupClusterQueryShapeInsightSummaries parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -46081,11 +46413,12 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/listGroupClusterQueryShapeInsightSummaries + x-xgen-operation-id-override: listQueryShapeSummaries /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. - operationId: testFailover + operationId: restartGroupClusterPrimaries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46117,9 +46450,10 @@ paths: summary: Test Failover for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/restartGroupClusterPrimaries x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: restartPrimaries /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -46130,7 +46464,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: listLegacyBackupRestoreJobs + operationId: listGroupClusterRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46172,14 +46506,15 @@ paths: summary: Return All Legacy Backup Restore Jobs tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterRestoreJobs + x-xgen-operation-id-override: listClusterRestoreJobs post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: createLegacyBackupRestoreJob + operationId: createGroupClusterRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46219,7 +46554,8 @@ paths: summary: Create One Legacy Backup Restore Job tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createGroupClusterRestoreJob + x-xgen-operation-id-override: createClusterRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -46230,7 +46566,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacyBackupRestoreJob + operationId: getGroupClusterRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46256,8 +46592,8 @@ paths: schema: $ref: '#/components/schemas/BackupRestoreJob' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: API predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -46273,11 +46609,12 @@ paths: summary: Return One Legacy Backup Restore Job tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterRestoreJob + x-xgen-operation-id-override: getClusterRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: description: Deletes the Search Nodes for the specified cluster. - operationId: deleteAtlasSearchDeployment + operationId: deleteGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46316,10 +46653,11 @@ paths: summary: Delete Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchDeployment + x-xgen-operation-id-override: deleteClusterSearchDeployment get: description: Returns the Search Nodes for the specified cluster. - operationId: getAtlasSearchDeployment + operationId: getGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46364,13 +46702,14 @@ paths: - Atlas Search x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchDeployment x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getClusterSearchDeployment patch: description: Updates the Search Nodes for the specified cluster. - operationId: updateAtlasSearchDeployment + operationId: updateGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46420,10 +46759,11 @@ paths: summary: Update Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchDeployment + x-xgen-operation-id-override: updateClusterSearchDeployment post: description: Creates Search Nodes for the specified cluster. - operationId: createAtlasSearchDeployment + operationId: createGroupClusterSearchDeployment parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -46476,14 +46816,15 @@ paths: summary: Create Search Nodes tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchDeployment + x-xgen-operation-id-override: createClusterSearchDeployment /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: description: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexesCluster + operationId: listGroupClusterSearchIndexes parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46504,7 +46845,7 @@ paths: $ref: '#/components/schemas/SearchIndexResponse' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -46526,13 +46867,14 @@ paths: summary: Return All Atlas Search Indexes for One Cluster tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndexes + x-xgen-operation-id-override: listClusterSearchIndexes post: description: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: createAtlasSearchIndex + operationId: createGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46574,14 +46916,15 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchIndex + x-xgen-operation-id-override: createClusterSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: description: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: listAtlasSearchIndexes + operationId: listGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46614,7 +46957,7 @@ paths: $ref: '#/components/schemas/SearchIndexResponse' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -46636,14 +46979,18 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndex + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: description: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndexByName + operationId: deleteGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46692,13 +47039,17 @@ paths: summary: Remove One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndexByName + x-xgen-method-verb-override: + customMethod: true + verb: deleteByName + x-xgen-operation-id-override: deleteIndexByName get: description: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndexByName + operationId: getGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46749,16 +47100,17 @@ paths: summary: Return One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndexByName x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: getByName + x-xgen-operation-id-override: getIndexByName patch: description: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndexByName + operationId: updateGroupClusterSearchIndexByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46818,17 +47170,18 @@ paths: summary: Update One Atlas Search Index by Name tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndexByName x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: updateByName + x-xgen-operation-id-override: updateIndexByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: deleteAtlasSearchIndex + operationId: deleteGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46868,13 +47221,14 @@ paths: summary: Remove One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndex + x-xgen-operation-id-override: deleteClusterSearchIndex get: description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: getAtlasSearchIndex + operationId: getGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46922,13 +47276,14 @@ paths: summary: Return One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndex + x-xgen-operation-id-override: getClusterSearchIndex patch: description: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Atlas Search Indexes url: https://dochub.mongodb.org/core/index-definitions-fts - operationId: updateAtlasSearchIndex + operationId: updateGroupClusterSearchIndex parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -46979,7 +47334,8 @@ paths: summary: Update One Atlas Search Index by ID tags: - Atlas Search - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndex + x-xgen-operation-id-override: updateClusterSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: deprecated: true @@ -46990,7 +47346,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacySnapshotSchedule + operationId: getGroupClusterSnapshotSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47009,7 +47365,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasSnapshotScheduleView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47023,7 +47379,8 @@ paths: summary: Return One Snapshot Schedule tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshotSchedule + x-xgen-operation-id-override: getClusterSnapshotSchedule patch: deprecated: true description: |- @@ -47033,7 +47390,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: updateLegacySnapshotSchedule + operationId: updateGroupClusterSnapshotSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47073,7 +47430,8 @@ paths: summary: Update Snapshot Schedule for One Cluster tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshotSchedule + x-xgen-operation-id-override: updateClusterSnapshotSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -47081,7 +47439,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: listLegacySnapshots + operationId: listGroupClusterSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47125,7 +47483,8 @@ paths: summary: Return All Legacy Backup Snapshots tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterSnapshots + x-xgen-operation-id-override: listClusterSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -47133,7 +47492,7 @@ paths: externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: deleteLegacySnapshot + operationId: deleteGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47171,14 +47530,15 @@ paths: summary: Remove One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteGroupClusterSnapshot + x-xgen-operation-id-override: deleteClusterSnapshot get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: getLegacySnapshot + operationId: getGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47204,7 +47564,7 @@ paths: schema: $ref: '#/components/schemas/BackupSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47218,14 +47578,15 @@ paths: summary: Return One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshot + x-xgen-operation-id-override: getClusterSnapshot patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. externalDocs: description: Cloud Backup Documentation url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule - operationId: updateLegacySnapshotRetention + operationId: updateGroupClusterSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47270,11 +47631,12 @@ paths: summary: Update Expiration Date for One Legacy Backup Snapshot tags: - Legacy Backup - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshot + x-xgen-operation-id-override: updateClusterSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getClusterStatus + operationId: getGroupClusterStatus parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47293,7 +47655,7 @@ paths: schema: $ref: '#/components/schemas/ClusterStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47307,11 +47669,12 @@ paths: summary: Return Status of All Cluster Operations tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterStatus + x-xgen-operation-id-override: getClusterStatus /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: post: description: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. - operationId: grantMongoDbEmployeeAccess + operationId: grantGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47352,11 +47715,12 @@ paths: summary: Grant MongoDB Employee Cluster Access for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantGroupClusterMongoDbEmployeeAccess + x-xgen-operation-id-override: grantMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. - operationId: pinFeatureCompatibilityVersion + operationId: pinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47396,11 +47760,12 @@ paths: summary: Pin Feature Compatibility Version for One Cluster in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinGroupClusterFeatureCompatibilityVersion + x-xgen-operation-id-override: pinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: post: description: Revokes a previously granted MongoDB employee cluster access. - operationId: revokeMongoDbEmployeeAccess + operationId: revokeGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -47433,11 +47798,12 @@ paths: summary: Revoke MongoDB Employee Cluster Access for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeGroupClusterMongoDbEmployeeAccess + x-xgen-operation-id-override: revokeMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. - operationId: unpinFeatureCompatibilityVersion + operationId: unpinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47472,11 +47838,12 @@ paths: summary: Unpin Feature Compatibility Version for One Cluster in One Project tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinGroupClusterFeatureCompatibilityVersion + x-xgen-operation-id-override: unpinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn''t available for `M0` free clusters, `M2`, `M5`, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: getHostLogs + operationId: downloadGroupClusterLog parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47547,14 +47914,15 @@ paths: summary: Download Logs for One Cluster Host in One Project tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/downloadGroupClusterLog x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadClusterLog /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listCloudProviderRegions + operationId: listGroupClusterProviderRegions parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47593,14 +47961,15 @@ paths: summary: Return All Cloud Provider Regions tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusterProviderRegions + x-xgen-operation-id-override: listClusterProviderRegions /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/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 - operationId: upgradeSharedCluster + operationId: upgradeGroupClusterTenantUpgrade parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47637,10 +48006,11 @@ paths: summary: Upgrade One Shared-Tier Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgrade x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: upgrade + x-xgen-operation-id-override: upgradeTenantUpgrade /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: deprecated: true @@ -47651,7 +48021,7 @@ paths: externalDocs: description: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster - operationId: upgradeSharedClusterToServerless + operationId: upgradeGroupClusterTenantUpgradeToServerless parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47689,14 +48059,15 @@ paths: summary: Upgrade One Shared-Tier Cluster to One Serverless Instance tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgradeToServerless x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: upgrade + x-xgen-operation-id-override: upgradeClusterToServerless /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. - operationId: getCollStatsLatencyNamespaceMetrics + operationId: listGroupCollStatMetrics parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -47716,14 +48087,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return all metric names + summary: Return All Metric Names tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupCollStatMetrics + x-xgen-operation-id-override: listCollStatMetrics /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringContainerByCloudProvider + operationId: listGroupContainers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47743,7 +48115,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -47763,10 +48135,10 @@ paths: summary: Return All Network Peering Containers in One Project for One Cloud Provider tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainers post: description: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createPeeringContainer + operationId: createGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47801,11 +48173,11 @@ paths: summary: Create One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupContainer /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePeeringContainer + operationId: deleteGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47839,10 +48211,10 @@ paths: summary: Remove One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupContainer get: description: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPeeringContainer + operationId: getGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47862,7 +48234,7 @@ paths: schema: $ref: '#/components/schemas/CloudProviderContainer' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47876,10 +48248,10 @@ paths: summary: Return One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupContainer patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updatePeeringContainer + operationId: updateGroupContainer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47922,11 +48294,11 @@ paths: summary: Update One Network Peering Container tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupContainer /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringContainers + operationId: listGroupContainerAll parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47953,14 +48325,14 @@ paths: summary: Return All Network Peering Containers in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainerAll x-xgen-method-verb-override: customMethod: "False" verb: list /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listCustomDatabaseRoles + operationId: listGroupCustomDbRoleRoles parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -47974,7 +48346,7 @@ paths: $ref: '#/components/schemas/UserCustomDBRole' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -47988,10 +48360,11 @@ paths: summary: Return All Custom Roles in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listGroupCustomDbRoleRoles + x-xgen-operation-id-override: listCustomDbRoles post: description: Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: createCustomDatabaseRole + operationId: createGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48026,11 +48399,12 @@ paths: summary: Create One Custom Role tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createGroupCustomDbRoleRole + x-xgen-operation-id-override: createCustomDbRole /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: deleteCustomDatabaseRole + operationId: deleteGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48062,10 +48436,11 @@ paths: summary: Remove One Custom Role from One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteGroupCustomDbRoleRole + x-xgen-operation-id-override: deleteCustomDbRole get: description: Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getCustomDatabaseRole + operationId: getGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48095,10 +48470,11 @@ paths: summary: Return One Custom Role in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getGroupCustomDbRoleRole + x-xgen-operation-id-override: getCustomDbRole patch: description: Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: updateCustomDatabaseRole + operationId: updateGroupCustomDbRoleRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48139,11 +48515,12 @@ paths: summary: Update One Custom Role in One Project tags: - Custom Database Roles - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateGroupCustomDbRoleRole + x-xgen-operation-id-override: updateCustomDbRole /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. - operationId: listFederatedDatabases + operationId: listGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48166,11 +48543,11 @@ paths: $ref: '#/components/schemas/DataLakeTenant' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48184,10 +48561,11 @@ paths: summary: Return All Federated Database Instances in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederation + x-xgen-operation-id-override: listDataFederation post: description: Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: createFederatedDatabase + operationId: createGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48226,11 +48604,12 @@ paths: summary: Create One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupDataFederation + x-xgen-operation-id-override: createDataFederation /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: deleteFederatedDatabase + operationId: deleteGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48258,10 +48637,11 @@ paths: summary: Remove One Federated Database Instance from One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederation + x-xgen-operation-id-override: deleteDataFederation get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: getFederatedDatabase + operationId: getGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48278,8 +48658,8 @@ paths: schema: $ref: '#/components/schemas/DataLakeTenant' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -48295,10 +48675,11 @@ paths: summary: Return One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederation + x-xgen-operation-id-override: getDataFederation patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. - operationId: updateFederatedDatabase + operationId: updateGroupDataFederation parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48343,11 +48724,12 @@ paths: summary: Update One Federated Database Instance in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateGroupDataFederation + x-xgen-operation-id-override: updateDataFederation /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnFederatedDatabaseQueryLimits + operationId: listGroupDataFederationLimits parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48367,11 +48749,11 @@ paths: $ref: '#/components/schemas/DataFederationTenantQueryLimit' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48385,11 +48767,12 @@ paths: summary: Return All Query Limits for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederationLimits + x-xgen-operation-id-override: listDataFederationLimits /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteOneDataFederationInstanceQueryLimit + operationId: deleteGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48437,10 +48820,11 @@ paths: summary: Delete One Query Limit for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederationLimit + x-xgen-operation-id-override: deleteDataFederationLimit get: description: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnFederatedDatabaseQueryLimit + operationId: getGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -48477,7 +48861,7 @@ paths: schema: $ref: '#/components/schemas/DataFederationTenantQueryLimit' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -48491,10 +48875,11 @@ paths: summary: Return One Federated Database Instance Query Limit for One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederationLimit + x-xgen-operation-id-override: getDataFederationLimit patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createOneDataFederationQueryLimit + operationId: setGroupDataFederationLimit parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48551,14 +48936,15 @@ paths: summary: Configure One Query Limit for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/setGroupDataFederationLimit x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: set + x-xgen-operation-id-override: setDataFederationLimit /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: downloadFederatedDatabaseQueryLogs + operationId: downloadGroupDataFederationQueryLogs parameters: - $ref: '#/components/parameters/groupId' - description: Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. @@ -48608,14 +48994,15 @@ paths: summary: Download Query Logs for One Federated Database Instance tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadGroupDataFederationQueryLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadFederationQueryLogs /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDatabaseUsers + operationId: listGroupDatabaseUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48642,13 +49029,14 @@ paths: summary: Return All Database Users in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listGroupDatabaseUsers + x-xgen-operation-id-override: listDatabaseUsers post: description: Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. externalDocs: description: Contact MongoDB Support url: https://cloud.mongodb.com/support - operationId: createDatabaseUser + operationId: createGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48774,11 +49162,12 @@ paths: summary: Create One Database User in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createGroupDatabaseUser + x-xgen-operation-id-override: createDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: deleteDatabaseUser + operationId: deleteGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48810,9 +49199,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. responses: "204": content: @@ -48830,10 +49219,11 @@ paths: summary: Remove One Database User from One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteGroupDatabaseUser + x-xgen-operation-id-override: deleteDatabaseUser get: description: Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabaseUser + operationId: getGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48865,9 +49255,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. responses: "200": content: @@ -48887,10 +49277,11 @@ paths: summary: Return One Database User from One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getGroupDatabaseUser + x-xgen-operation-id-override: getDatabaseUser patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. - operationId: updateDatabaseUser + operationId: updateGroupDatabaseUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48922,9 +49313,9 @@ paths: example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' type: string x-xgen-IPA-exception: - xgen-IPA-117-description-must-not-use-html: Description predates IPA validation + xgen-IPA-117-description-must-not-use-html: Description predates IPA validation. xgen-IPA-117-description-should-not-use-inline-links: Parameters don't support externalDocs - xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation + xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation. requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -48955,11 +49346,12 @@ paths: summary: Update One Database User in One Project tags: - Database Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateGroupDatabaseUser + x-xgen-operation-id-override: updateDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDatabaseUserCertificates + operationId: listGroupDatabaseUserCerts parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -48994,7 +49386,8 @@ paths: summary: Return All X.509 Certificates Assigned to One Database User tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listGroupDatabaseUserCerts + x-xgen-operation-id-override: listDatabaseUserCerts post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -49005,7 +49398,7 @@ paths: externalDocs: description: Self-Managed X.509 url: https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509 - operationId: createDatabaseUserCertificate + operationId: createGroupDatabaseUserCert parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49047,14 +49440,15 @@ paths: summary: Create One X.509 Certificate for One Database User tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createGroupDatabaseUserCert + x-xgen-operation-id-override: createDatabaseUserCert /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ - operationId: listAccessLogsByClusterName + operationId: getGroupDbAccessHistoryCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49121,14 +49515,15 @@ paths: summary: Return Database Access History for One Cluster by Cluster Name tags: - Access Tracking - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryCluster + x-xgen-operation-id-override: getAccessHistoryCluster /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ - operationId: listAccessLogsByHostname + operationId: getGroupDbAccessHistoryProcess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49192,14 +49587,15 @@ paths: summary: Return Database Access History for One Cluster by Hostname tags: - Access Tracking - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryProcess + x-xgen-operation-id-override: getAccessHistoryProcess /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. **LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. - operationId: getEncryptionAtRest + operationId: getGroupEncryptionAtRest parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49211,8 +49607,8 @@ paths: schema: $ref: '#/components/schemas/EncryptionAtRest' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -49223,16 +49619,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project + summary: Return One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRest + x-xgen-operation-id-override: getEncryptionAtRest patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. - operationId: updateEncryptionAtRest + operationId: updateGroupEncryptionAtRest parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49249,7 +49646,7 @@ paths: - To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object. - To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object. - - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object. + - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object For authentication, you must provide either serviceAccountKey (static credentials) or roleId (service-account–based authentication) Once roleId is configured, serviceAccountKey is no longer supported. If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint. required: true @@ -49273,14 +49670,15 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Update Encryption at Rest Configuration for One Project + summary: Update Encryption at Rest Configuration in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateGroupEncryptionAtRest + x-xgen-operation-id-override: updateEncryptionAtRest /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. - operationId: getEncryptionAtRestPrivateEndpointsForCloudProvider + operationId: listGroupEncryptionAtRestPrivateEndpoints parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49313,13 +49711,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project + summary: Return Private Endpoints for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/listGroupEncryptionAtRestPrivateEndpoints + x-xgen-operation-id-override: listRestPrivateEndpoints post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. - operationId: createEncryptionAtRestPrivateEndpoint + operationId: createGroupEncryptionAtRestPrivateEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49356,14 +49755,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management + summary: Create One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createGroupEncryptionAtRestPrivateEndpoint + x-xgen-operation-id-override: createRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - operationId: requestEncryptionAtRestPrivateEndpointDeletion + operationId: requestGroupEncryptionAtRestPrivateEndpointDeletion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49398,16 +49798,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Delete One Private Endpoint for Encryption at Rest Using Customer Key Management + summary: Delete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestGroupEncryptionAtRestPrivateEndpointDeletion x-xgen-method-verb-override: customMethod: "True" verb: requestDeletion + x-xgen-operation-id-override: requestPrivateEndpointDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - operationId: getEncryptionAtRestPrivateEndpoint + operationId: getGroupEncryptionAtRestPrivateEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49435,7 +49836,7 @@ paths: schema: $ref: '#/components/schemas/EARPrivateEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -49446,17 +49847,18 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management + summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project tags: - Encryption at Rest using Customer Key Management - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRestPrivateEndpoint + x-xgen-operation-id-override: getRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/events: get: description: |- Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. - operationId: listProjectEvents + operationId: listGroupEvents parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49524,7 +49926,7 @@ paths: schema: $ref: '#/components/schemas/GroupPaginatedEventView' x-xgen-IPA-exception: - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -49542,7 +49944,7 @@ paths: summary: Return Events from One Project tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listGroupEvents /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -49552,7 +49954,7 @@ paths: externalDocs: description: Return Events from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents - operationId: getProjectEvent + operationId: getGroupEvent parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49577,7 +49979,7 @@ paths: schema: $ref: '#/components/schemas/EventViewForNdsGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -49591,11 +49993,11 @@ paths: summary: Return One Event from One Project tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getGroupEvent /api/atlas/v2/groups/{groupId}/flexClusters: get: description: Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listFlexClusters + operationId: listGroupFlexClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49624,10 +50026,11 @@ paths: summary: Return All Flex Clusters from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listGroupFlexClusters + x-xgen-operation-id-override: listFlexClusters post: description: Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createFlexCluster + operationId: createGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49664,11 +50067,12 @@ paths: summary: Create One Flex Cluster in One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createGroupFlexCluster + x-xgen-operation-id-override: createFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}: delete: description: Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteFlexCluster + operationId: deleteGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -49701,10 +50105,11 @@ paths: summary: Remove One Flex Cluster from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteGroupFlexCluster + x-xgen-operation-id-override: deleteFlexCluster get: description: Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getFlexCluster + operationId: getGroupFlexCluster parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -49723,7 +50128,7 @@ paths: schema: $ref: '#/components/schemas/FlexClusterDescription20241113' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-11-13" description: OK "400": @@ -49741,10 +50146,11 @@ paths: summary: Return One Flex Cluster from One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getGroupFlexCluster + x-xgen-operation-id-override: getFlexCluster patch: description: Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateFlexCluster + operationId: updateGroupFlexCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49786,11 +50192,12 @@ paths: summary: Update One Flex Cluster in One Project tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateGroupFlexCluster + x-xgen-operation-id-override: updateFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download: post: description: Requests one snapshot for the specified flex cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: downloadFlexBackup + operationId: downloadGroupFlexClusterBackup parameters: - description: Human-readable label that identifies the flex cluster. in: path @@ -49832,13 +50239,14 @@ paths: summary: Download One Flex Cluster Snapshot tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadGroupFlexClusterBackup x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: downloadFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: description: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listFlexBackupRestoreJobs + operationId: listGroupFlexClusterBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49874,10 +50282,11 @@ paths: summary: Return All Restore Jobs for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listGroupFlexClusterBackupRestoreJobs + x-xgen-operation-id-override: listFlexRestoreJobs post: description: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createFlexBackupRestoreJob + operationId: createGroupFlexClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49916,14 +50325,15 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Flex Cluster + summary: Create One Restore Job for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createGroupFlexClusterBackupRestoreJob + x-xgen-operation-id-override: createFlexRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getFlexBackupRestoreJob + operationId: getGroupFlexClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -49963,11 +50373,12 @@ paths: summary: Return One Restore Job for One Flex Cluster tags: - Flex Restore Jobs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getGroupFlexClusterBackupRestoreJob + x-xgen-operation-id-override: getFlexRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots: get: description: Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listFlexBackups + operationId: listGroupFlexClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50000,14 +50411,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Snapshots of One Flex Cluster + summary: Return All Snapshots for One Flex Cluster tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listGroupFlexClusterBackupSnapshots + x-xgen-operation-id-override: listFlexBackupSnapshots /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getFlexBackup + operationId: getGroupFlexClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50044,14 +50456,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Snapshot of One Flex Cluster + summary: Return One Snapshot for One Flex Cluster tags: - Flex Snapshots - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getGroupFlexClusterBackupSnapshot + x-xgen-operation-id-override: getFlexBackupSnapshot /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: post: description: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. - operationId: upgradeFlexCluster + operationId: tenantGroupFlexClusterUpgrade parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50088,11 +50501,12 @@ paths: summary: Upgrade One Flex Cluster tags: - Flex Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/tenantGroupFlexClusterUpgrade + x-xgen-operation-id-override: tenantUpgrade /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: listMetricTypes + operationId: listGroupHostFtsMetrics parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/groupId' @@ -50120,11 +50534,12 @@ paths: summary: Return All Atlas Search Metric Types for One Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetrics + x-xgen-operation-id-override: listHostFtsMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: getIndexMetrics + operationId: getGroupHostFtsMetricIndexMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/indexName' @@ -50166,7 +50581,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementsIndexes' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50184,11 +50599,12 @@ paths: summary: Return Atlas Search Metrics for One Index in One Namespace tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupHostFtsMetricIndexMeasurements + x-xgen-operation-id-override: getIndexMeasurements /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. - operationId: listIndexMetrics + operationId: listGroupHostFtsMetricIndexMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/databaseName' @@ -50229,7 +50645,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementsIndexes' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50247,11 +50663,15 @@ paths: summary: Return All Atlas Search Index Metrics for One Namespace tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricIndexMeasurements + x-xgen-method-verb-override: + customMethod: false + verb: list + x-xgen-operation-id-override: listIndexMeasurements /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. - operationId: getMeasurements + operationId: listGroupHostFtsMetricMeasurements parameters: - $ref: '#/components/parameters/processId' - $ref: '#/components/parameters/groupId' @@ -50307,11 +50727,12 @@ paths: summary: Return Atlas Search Hardware and Status Metrics tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricMeasurements + x-xgen-operation-id-override: listMeasurements /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: listThirdPartyIntegrations + operationId: listGroupIntegrations parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50340,11 +50761,11 @@ paths: summary: Return All Active Third-Party Service Integrations tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listGroupIntegrations /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: deleteThirdPartyIntegration + operationId: deleteGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -50386,10 +50807,10 @@ paths: summary: Remove One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteGroupIntegration get: description: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: getThirdPartyIntegration + operationId: getGroupIntegration parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50419,7 +50840,7 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyIntegration' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50435,10 +50856,10 @@ paths: summary: Return One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getGroupIntegration post: description: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per `{INTEGRATION-TYPE}`. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: createThirdPartyIntegration + operationId: createGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -50491,13 +50912,13 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Configure One Third-Party Service Integration + summary: Create One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createGroupIntegration put: description: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. - operationId: updateThirdPartyIntegration + operationId: updateGroupIntegration parameters: - description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. in: path @@ -50537,7 +50958,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedIntegrationView' x-xgen-IPA-exception: - xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50553,12 +50974,12 @@ paths: summary: Update One Third-Party Service Integration tags: - Third-Party Integrations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateGroupIntegration /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true description: Returns all pending invitations to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: listProjectInvitations + operationId: listGroupInvites parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50578,12 +50999,12 @@ paths: $ref: '#/components/schemas/GroupInvitation' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -50594,14 +51015,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Project Invitations + summary: Return All Invitations in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupInvites patch: deprecated: true description: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectInvitation + operationId: updateGroupInvites parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50632,14 +51053,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Project Invitation + summary: Update One Invitation in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInvites post: deprecated: true description: Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: createProjectInvitation + operationId: createGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' @@ -50668,15 +51089,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Invite One MongoDB Cloud User to One Project + summary: Create Invitation for One MongoDB Cloud User in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroupInvite /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProjectInvitation + operationId: deleteGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50702,14 +51123,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Remove One Project Invitation + summary: Remove One Invitation from One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupInvite get: deprecated: true description: Returns the details of one pending invitation to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getProjectInvitation + operationId: getGroupInvite parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50729,7 +51150,7 @@ paths: $ref: '#/components/schemas/GroupInvitation' x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -50740,14 +51161,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Project Invitation + summary: Return One Invitation in One Project by Invitation ID tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupInvite patch: deprecated: true description: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectInvitationById + operationId: updateGroupInviteById parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -50784,14 +51205,18 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Project Invitation by Invitation ID + summary: Update One Invitation in One Project by Invitation ID tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInviteById + x-xgen-method-verb-override: + customMethod: false + verb: updateById + x-xgen-operation-id-override: updateInviteById /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: Returns all IP addresses for this project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: returnAllIpAddresses + operationId: getGroupIpAddresses parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -50803,7 +51228,7 @@ paths: schema: $ref: '#/components/schemas/GroupIPAddresses' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -50817,11 +51242,11 @@ paths: summary: Return All IP Addresses for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupIpAddresses /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listProjectLimits + operationId: listGroupLimits parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50835,11 +51260,11 @@ paths: $ref: '#/components/schemas/DataFederationLimit' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50857,21 +51282,21 @@ paths: summary: Return All Limits for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupLimits /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteProjectLimit + operationId: deleteGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -50880,7 +51305,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -50899,7 +51323,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50925,20 +51348,20 @@ paths: summary: Remove One Project Limit tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupLimit get: description: Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectLimit + operationId: getGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -50947,7 +51370,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -50966,7 +51388,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -50978,7 +51399,7 @@ paths: schema: $ref: '#/components/schemas/DataFederationLimit' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -50996,23 +51417,23 @@ paths: summary: Return One Limit for One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupLimit patch: description: |- Sets the specified project limit. To use this resource, the requesting Service Account or API Key must have the Project Owner role. **NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. - operationId: setProjectLimit + operationId: setGroupLimit parameters: - description: | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | + | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | - | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | + | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 100 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | @@ -51021,7 +51442,6 @@ paths: | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| - | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | in: path name: limitName required: true @@ -51040,7 +51460,6 @@ paths: - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - - atlas.project.deployment.salesSoldM0s type: string - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51075,7 +51494,7 @@ paths: summary: Set One Project Limit tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setGroupLimit x-xgen-method-verb-override: customMethod: "True" verb: set @@ -51092,7 +51511,7 @@ paths: externalDocs: description: Validate Migration url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration - operationId: createPushMigration + operationId: createGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51132,14 +51551,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Migrate One Local Managed Cluster to MongoDB Atlas + summary: Create One Migration for One Local Managed Cluster to MongoDB Atlas tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createGroupLiveMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. - operationId: getPushMigration + operationId: getGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/liveMigrationId' @@ -51164,11 +51583,11 @@ paths: summary: Return One Migration Job tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: cutoverMigration + operationId: cutoverGroupLiveMigration parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/liveMigrationId' @@ -51193,13 +51612,14 @@ paths: summary: Cut Over One Migrated Cluster tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverGroupLiveMigration x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: cutoverMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: validateMigration + operationId: validateGroupLiveMigrations parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -51242,13 +51662,14 @@ paths: summary: Validate One Migration Request tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateGroupLiveMigrations x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: validateLiveMigrations /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: getValidationStatus + operationId: getGroupLiveMigrationValidateStatus parameters: - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal digit string that identifies the validation job. @@ -51281,14 +51702,15 @@ paths: summary: Return One Migration Validation Job tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigrationValidateStatus x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: getStatus + x-xgen-operation-id-override: getMigrationValidateStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: resetMaintenanceWindow + operationId: resetGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51311,13 +51733,14 @@ paths: summary: Reset One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetGroupMaintenanceWindow x-xgen-method-verb-override: customMethod: "True" verb: reset + x-xgen-operation-id-override: resetMaintenanceWindow get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getMaintenanceWindow + operationId: getGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51329,7 +51752,7 @@ paths: schema: $ref: '#/components/schemas/GroupMaintenanceWindow' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51343,10 +51766,11 @@ paths: summary: Return One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getGroupMaintenanceWindow + x-xgen-operation-id-override: getMaintenanceWindow patch: description: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateMaintenanceWindow + operationId: updateGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51376,11 +51800,12 @@ paths: summary: Update One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateGroupMaintenanceWindow + x-xgen-operation-id-override: updateMaintenanceWindow /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: toggleMaintenanceAutoDefer + operationId: toggleGroupMaintenanceWindowAutoDefer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51403,14 +51828,15 @@ paths: summary: Toggle Automatic Deferral of Maintenance for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleGroupMaintenanceWindowAutoDefer x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleMaintenanceAutoDefer /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deferMaintenanceWindow + operationId: deferGroupMaintenanceWindow parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51433,13 +51859,14 @@ paths: summary: Defer One Maintenance Window for One Project tags: - Maintenance Windows - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferGroupMaintenanceWindow x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: deferMaintenanceWindow /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. - operationId: getManagedSlowMs + operationId: getGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51451,7 +51878,7 @@ paths: schema: type: boolean x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -51467,11 +51894,12 @@ paths: summary: Return Managed Slow Operation Threshold Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupManagedSlowMs + x-xgen-operation-id-override: getManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: disableSlowOperationThresholding + operationId: disableGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51495,13 +51923,14 @@ paths: summary: Disable Managed Slow Operation Threshold tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableGroupManagedSlowMs x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: disableManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: enableSlowOperationThresholding + operationId: enableGroupManagedSlowMs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51525,13 +51954,14 @@ paths: summary: Enable Managed Slow Operation Threshold tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableGroupManagedSlowMs x-xgen-method-verb-override: - customMethod: "True" + customMethod: true + x-xgen-operation-id-override: enableManagedSlowMs /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. - operationId: getProjectLtsVersions + operationId: getGroupMongoDbVersions parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -51576,8 +52006,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAvailableVersionView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51595,11 +52025,12 @@ paths: summary: Return All Available MongoDB LTS Versions for Clusters in One Project tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupMongoDbVersions + x-xgen-operation-id-override: getMongoDbVersions /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPeeringConnections + operationId: listGroupPeers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51618,7 +52049,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -51640,13 +52071,13 @@ paths: summary: Return All Network Peering Connections in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupPeers post: description: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: description: Azure Network Peering Prerequisites url: https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites - operationId: createPeeringConnection + operationId: createGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51681,11 +52112,11 @@ paths: summary: Create One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupPeer /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePeeringConnection + operationId: deleteGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51718,10 +52149,10 @@ paths: summary: Remove One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupPeer get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPeeringConnection + operationId: getGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51740,7 +52171,7 @@ paths: schema: $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51756,10 +52187,10 @@ paths: summary: Return One Network Peering Connection in One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupPeer patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updatePeeringConnection + operationId: updateGroupPeer parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51801,12 +52232,12 @@ paths: summary: Update One Network Peering Connection tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupPeer /api/atlas/v2/groups/{groupId}/pipelines: get: deprecated: true description: Returns a list of Data Lake Pipelines. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelines + operationId: listGroupPipelines parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51819,12 +52250,12 @@ paths: $ref: '#/components/schemas/DataLakeIngestionPipeline' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation - x-sunset: "2025-09-09" + xgen-IPA-124-array-max-items: Schema predates IPA validation. + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51840,14 +52271,15 @@ paths: summary: Return All Data Lake Pipelines in One Project tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelines + x-xgen-operation-id-override: listPipelines post: deprecated: true description: Creates one Data Lake Pipeline. externalDocs: description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide. url: https://dochub.mongodb.org/core/data-lake-deprecation - operationId: createPipeline + operationId: createGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51864,7 +52296,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -51880,12 +52312,13 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createGroupPipeline + x-xgen-operation-id-override: createPipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: deprecated: true description: Removes one Data Lake Pipeline. - operationId: deletePipeline + operationId: deleteGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51900,7 +52333,7 @@ paths: "200": content: application/vnd.atlas.2023-01-01+json: - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "401": @@ -51914,11 +52347,12 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipeline + x-xgen-operation-id-override: deletePipeline get: deprecated: true description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPipeline + operationId: getGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51936,9 +52370,9 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -51954,11 +52388,12 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipeline + x-xgen-operation-id-override: getPipeline patch: deprecated: true description: Updates one Data Lake Pipeline. - operationId: updatePipeline + operationId: updateGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -51982,7 +52417,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52000,12 +52435,13 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updateGroupPipeline + x-xgen-operation-id-override: updatePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: deprecated: true description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineSchedules + operationId: getGroupPipelineAvailableSchedules parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52026,11 +52462,11 @@ paths: $ref: '#/components/schemas/DiskBackupApiPolicyItem' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation - x-sunset: "2025-09-09" + xgen-IPA-124-array-max-items: Schema predates IPA validation. + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52046,12 +52482,13 @@ paths: summary: Return All Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSchedules + x-xgen-operation-id-override: getAvailablePipelineSchedules /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: deprecated: true description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineSnapshots + operationId: getGroupPipelineAvailableSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52078,10 +52515,10 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedBackupSnapshotView' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52097,12 +52534,13 @@ paths: summary: Return All Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSnapshots + x-xgen-operation-id-override: getAvailablePipelineSnapshots /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: deprecated: true description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: pausePipeline + operationId: pauseGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52120,7 +52558,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52136,14 +52574,15 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pauseGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: pausePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: deprecated: true description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: resumePipeline + operationId: resumeGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52161,7 +52600,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DataLakeIngestionPipeline' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52177,14 +52616,15 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumeGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: resumePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: deprecated: true description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPipelineRuns + operationId: listGroupPipelineRuns parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52199,7 +52639,7 @@ paths: format: date-time type: string x-xgen-IPA-exception: - xgen-IPA-121-date-time-fields-mention-iso-8601: Schema predates IPA validation + xgen-IPA-121-date-time-fields-mention-iso-8601: Schema predates IPA validation. - description: Human-readable label that identifies the Data Lake Pipeline. in: path name: pipelineName @@ -52213,7 +52653,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedPipelineRunView' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52229,12 +52669,13 @@ paths: summary: Return All Data Lake Pipeline Runs in One Project tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelineRuns + x-xgen-operation-id-override: listPipelineRuns /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. - operationId: deletePipelineRunDataset + operationId: deleteGroupPipelineRun parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52260,7 +52701,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/RequestAccepted' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: Accepted "400": @@ -52276,11 +52717,12 @@ paths: summary: Delete One Pipeline Run Dataset tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipelineRun + x-xgen-operation-id-override: deletePipelineRun get: deprecated: true description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPipelineRun + operationId: getGroupPipelineRun parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52306,9 +52748,9 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/IngestionPipelineRun' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52324,12 +52766,13 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineRun + x-xgen-operation-id-override: getPipelineRun /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. - operationId: triggerSnapshotIngestion + operationId: triggerGroupPipeline parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52354,7 +52797,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/IngestionPipelineRun' - x-sunset: "2025-09-09" + x-sunset: "2025-09-30" x-xgen-version: "2023-01-01" description: OK "400": @@ -52370,13 +52813,14 @@ paths: summary: Trigger On-Demand Snapshot Ingestion tags: - Data Lake Pipelines - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerGroupPipeline x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: triggerPipeline /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listPrivateEndpointServices + operationId: listGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52393,7 +52837,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. responses: "200": content: @@ -52403,11 +52847,11 @@ paths: $ref: '#/components/schemas/EndpointService' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52423,11 +52867,12 @@ paths: summary: Return All Private Endpoint Services for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: listPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePrivateEndpointService + operationId: deleteGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52444,7 +52889,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. in: path name: endpointServiceId @@ -52471,10 +52916,11 @@ paths: summary: Remove One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: deletePrivateEndpointService get: description: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateEndpointService + operationId: getGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52491,7 +52937,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. in: path name: endpointServiceId @@ -52506,7 +52952,7 @@ paths: schema: $ref: '#/components/schemas/EndpointService' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52522,11 +52968,12 @@ paths: summary: Return One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: getPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. - operationId: createPrivateEndpoint + operationId: createGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52543,7 +52990,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. in: path name: endpointServiceId @@ -52583,11 +53030,12 @@ paths: summary: Create One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: createPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deletePrivateEndpoint + operationId: deleteGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52604,7 +53052,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. in: path name: endpointId @@ -52638,10 +53086,11 @@ paths: summary: Remove One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: deletePrivateEndpoint get: description: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateEndpoint + operationId: getGroupPrivateEndpointEndpointServiceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52658,7 +53107,7 @@ paths: - GCP type: string x-xgen-IPA-exception: - xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation + xgen-IPA-119-no-default-for-cloud-providers: Schema predates IPA validation. - description: Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. in: path name: endpointId @@ -52680,7 +53129,7 @@ paths: schema: $ref: '#/components/schemas/PrivateLinkEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52696,14 +53145,15 @@ paths: summary: Return One Private Endpoint for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointServiceEndpoint + x-xgen-operation-id-override: getPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Private Endpoint Concepts url: https://dochub.mongodb.org/core/private-endpoint-concepts - operationId: createPrivateEndpointService + operationId: createGroupPrivateEndpointEndpointService parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52736,11 +53186,12 @@ paths: summary: Create One Private Endpoint Service for One Provider tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointService + x-xgen-operation-id-override: createPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getRegionalizedPrivateEndpointSetting + operationId: getGroupPrivateEndpointRegionalMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52764,13 +53215,14 @@ paths: summary: Return Regionalized Private Endpoint Status tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointRegionalMode x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getRegionalEndpointMode patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. - operationId: toggleRegionalizedPrivateEndpointSetting + operationId: toggleGroupPrivateEndpointRegionalMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52803,17 +53255,18 @@ paths: summary: Toggle Regionalized Private Endpoint Status tags: - Private Endpoint Services - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleGroupPrivateEndpointRegionalMode x-xgen-method-verb-override: customMethod: "True" verb: toggle + x-xgen-operation-id-override: toggleRegionalEndpointMode /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: |- Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: listServerlessPrivateEndpoints + operationId: listGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52833,11 +53286,11 @@ paths: $ref: '#/components/schemas/ServerlessTenantEndpoint' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52853,7 +53306,8 @@ paths: summary: Return All Private Endpoints for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: listServerlessPrivateEndpoint post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -52864,7 +53318,7 @@ paths: externalDocs: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint - operationId: createServerlessPrivateEndpoint + operationId: createGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52903,14 +53357,15 @@ paths: summary: Create One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: createServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: |- Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: deleteServerlessPrivateEndpoint + operationId: deleteGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52947,13 +53402,14 @@ paths: summary: Remove One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: deleteServerlessPrivateEndpoint get: description: |- Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: getServerlessPrivateEndpoint + operationId: getGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -52978,7 +53434,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessTenantEndpoint' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -52994,13 +53450,14 @@ paths: summary: Return One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: getServerlessPrivateEndpoint patch: description: |- Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. - operationId: updateServerlessPrivateEndpoint + operationId: updateGroupPrivateEndpointServerlessInstanceEndpoint parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53046,7 +53503,8 @@ paths: summary: Update One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateGroupPrivateEndpointServerlessInstanceEndpoint + x-xgen-operation-id-override: updateServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -53054,7 +53512,7 @@ paths: externalDocs: description: Changes to Connection Strings url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/ - operationId: verifyConnectViaPeeringOnlyModeForOneProject + operationId: verifyGroupPrivateIpMode parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53066,7 +53524,7 @@ paths: schema: $ref: '#/components/schemas/PrivateIPModeView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53080,17 +53538,18 @@ paths: summary: Verify Connect via Peering-Only Mode for One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyGroupPrivateIpMode x-xgen-method-verb-override: customMethod: "True" verb: verify + x-xgen-operation-id-override: verifyPrivateIpMode patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Changes to Connection Strings url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/ - operationId: disablePeering + operationId: disableGroupPrivateIpModePeering parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53123,14 +53582,15 @@ paths: summary: Disable Connect via Peering-Only Mode for One Project tags: - Network Peering - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disableGroupPrivateIpModePeering x-xgen-method-verb-override: customMethod: "True" verb: disablePeering + x-xgen-operation-id-override: disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: listDataFederationPrivateEndpoints + operationId: listGroupPrivateNetworkSettingEndpointIds parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53159,7 +53619,8 @@ paths: summary: Return All Federated Database Instance and Online Archive Private Endpoints in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupPrivateNetworkSettingEndpointIds + x-xgen-operation-id-override: listPrivateEndpointIds post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -53181,7 +53642,7 @@ paths: `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. - operationId: createDataFederationPrivateEndpoint + operationId: createGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53214,11 +53675,12 @@ paths: summary: Create One Federated Database Instance and Online Archive Private Endpoint for One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: createPrivateEndpointId /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteDataFederationPrivateEndpoint + operationId: deleteGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53247,10 +53709,11 @@ paths: summary: Remove One Federated Database Instance and Online Archive Private Endpoint from One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: deletePrivateEndpointId get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. - operationId: getDataFederationPrivateEndpoint + operationId: getGroupPrivateNetworkSettingEndpointId parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53283,11 +53746,12 @@ paths: summary: Return One Federated Database Instance and Online Archive Private Endpoint in One Project tags: - Data Federation - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupPrivateNetworkSettingEndpointId + x-xgen-operation-id-override: getPrivateEndpointId /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listAtlasProcesses + operationId: listGroupProcesses parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53314,11 +53778,11 @@ paths: summary: Return All MongoDB Processes in One Project tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcesses /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getAtlasProcess + operationId: getGroupProcess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53338,7 +53802,7 @@ paths: schema: $ref: '#/components/schemas/ApiHostView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53352,11 +53816,11 @@ paths: summary: Return One MongoDB Process by ID tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcess /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace. - operationId: getCollStatsLatencyNamespaceHostMeasurements + operationId: listGroupProcessCollStatMeasurements parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/processId' @@ -53421,11 +53885,12 @@ paths: summary: Return Host-Level Query Latency tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupProcessCollStatMeasurements + x-xgen-operation-id-override: listProcessMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. - operationId: getCollStatsLatencyNamespacesForHost + operationId: getGroupProcessCollStatNamespaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/processId' @@ -53449,20 +53914,21 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Ranked Namespaces from a Host + summary: Return Ranked Namespaces from One Host tags: - Collection Level Metrics - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupProcessCollStatNamespaces x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getProcessNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Operational Limits url: https://www.mongodb.com/docs/atlas/reference/limitations/ - operationId: listDatabases + operationId: listGroupProcessDatabases parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53497,11 +53963,12 @@ paths: summary: Return Available Databases for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDatabases + x-xgen-operation-id-override: listDatabases /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabase + operationId: getGroupProcessDatabase parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53527,7 +53994,7 @@ paths: schema: $ref: '#/components/schemas/MesurementsDatabase' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53541,11 +54008,12 @@ paths: summary: Return One Database for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabase + x-xgen-operation-id-override: getDatabase /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDatabaseMeasurements + operationId: getGroupProcessDatabaseMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53597,7 +54065,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53611,11 +54079,12 @@ paths: summary: Return Measurements for One Database in One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabaseMeasurements + x-xgen-operation-id-override: getDatabaseMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDiskPartitions + operationId: listGroupProcessDisks parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53650,11 +54119,12 @@ paths: summary: Return Available Disks for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDisks + x-xgen-operation-id-override: listProcessDisks /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listDiskMeasurements + operationId: getGroupProcessDisk parameters: - $ref: '#/components/parameters/envelope' - description: Human-readable label of the disk or partition to which the measurements apply. @@ -53679,7 +54149,7 @@ paths: schema: $ref: '#/components/schemas/MeasurementDiskPartition' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53693,7 +54163,8 @@ paths: summary: Return Measurements for One Disk tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDisk + x-xgen-operation-id-override: getProcessDisk /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -53704,7 +54175,7 @@ paths: - Amount of free and used disk space on the disk partition used for the MongoDB process To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getDiskMeasurements + operationId: getGroupProcessDiskMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53768,7 +54239,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53782,7 +54253,8 @@ paths: summary: Return Measurements of One Disk for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDiskMeasurements + x-xgen-operation-id-override: getProcessDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -53794,7 +54266,7 @@ paths: - Measurements for the host, such as CPU usage or number of I/O operations To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getHostMeasurements + operationId: getGroupProcessMeasurements parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -53970,7 +54442,7 @@ paths: schema: $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -53984,11 +54456,12 @@ paths: summary: Return Measurements for One MongoDB Process tags: - Monitoring and Logs - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessMeasurements + x-xgen-operation-id-override: getProcessMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSlowQueryNamespaces + operationId: listGroupProcessPerformanceAdvisorNamespaces parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54044,11 +54517,12 @@ paths: summary: Return All Namespaces for One Host tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorNamespaces + x-xgen-operation-id-override: listPerformanceAdvisorNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. - operationId: listSlowQueries + operationId: listGroupProcessPerformanceAdvisorSlowQueryLogs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54139,11 +54613,12 @@ paths: summary: Return Slow Queries tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSlowQueryLogs + x-xgen-operation-id-override: listSlowQueryLogs /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listSuggestedIndexes + operationId: listGroupProcessPerformanceAdvisorSuggestedIndexes parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54223,11 +54698,12 @@ paths: summary: Return All Suggested Indexes tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSuggestedIndexes + x-xgen-operation-id-override: listSuggestedIndexes /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. - operationId: deletePushBasedLogConfiguration + operationId: deleteGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54251,10 +54727,11 @@ paths: summary: Disable Push-Based Log Export for One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deleteGroupPushBasedLogExport + x-xgen-operation-id-override: deleteLogExport get: description: Fetches the current project level settings for the push-based log export feature. - operationId: getPushBasedLogConfiguration + operationId: getGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54278,16 +54755,17 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return Push-Based Log Export Configuration for One Project + summary: Return One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getGroupPushBasedLogExport x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getLogExport patch: description: Updates the project level settings for the push-based log export feature. - operationId: updatePushBasedLogConfiguration + operationId: updateGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54316,13 +54794,14 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update Push-Based Log Export for One Project + summary: Update One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updateGroupPushBasedLogExport + x-xgen-operation-id-override: updateLogExport post: description: Configures the project level settings for the push-based log export feature. - operationId: createPushBasedLogConfiguration + operationId: createGroupPushBasedLogExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54351,14 +54830,15 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Enable Push-Based Log Export for One Project + summary: Create One Push-Based Log Export Configuration in One Project tags: - Push-Based Log Export - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createGroupPushBasedLogExport + x-xgen-operation-id-override: createLogExport /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: loadSampleDataset + operationId: requestGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54392,14 +54872,15 @@ paths: summary: Load Sample Dataset into One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/requestGroupSampleDatasetLoad x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: request + x-xgen-operation-id-override: requestSampleDatasetLoad /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getSampleDatasetLoadStatus + operationId: getGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54417,7 +54898,7 @@ paths: schema: $ref: '#/components/schemas/SampleDatasetStatus' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -54431,7 +54912,8 @@ paths: summary: Return Status of Sample Dataset Load for One Cluster tags: - Clusters - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupSampleDatasetLoad + x-xgen-operation-id-override: getSampleDatasetLoad /api/atlas/v2/groups/{groupId}/serverless: get: description: |- @@ -54441,7 +54923,7 @@ paths: externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters - operationId: listServerlessInstances + operationId: listGroupServerlessInstances parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54470,7 +54952,11 @@ paths: summary: Return All Serverless Instances in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listGroupServerlessInstances + x-xgen-method-verb-override: + customMethod: false + verb: listInstances + x-xgen-operation-id-override: listServerlessInstances post: description: |- Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. @@ -54479,7 +54965,7 @@ paths: externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster - operationId: createServerlessInstance + operationId: createGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54516,7 +55002,11 @@ paths: summary: Create One Serverless Instance in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: createInstance + x-xgen-operation-id-override: createServerlessInstance /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: |- @@ -54526,7 +55016,7 @@ paths: externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs - operationId: listServerlessBackupRestoreJobs + operationId: listGroupServerlessBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54562,7 +55052,8 @@ paths: summary: Return All Restore Jobs for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupRestoreJobs + x-xgen-operation-id-override: listServerlessRestoreJobs post: description: |- Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -54571,7 +55062,7 @@ paths: externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob - operationId: createServerlessBackupRestoreJob + operationId: createGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54610,10 +55101,11 @@ paths: $ref: '#/components/responses/conflict' "500": $ref: '#/components/responses/internalServerError' - summary: Restore One Snapshot of One Serverless Instance + summary: Create One Restore Job for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupServerlessBackupRestoreJob + x-xgen-operation-id-override: createServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: |- @@ -54623,7 +55115,7 @@ paths: externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob - operationId: getServerlessBackupRestoreJob + operationId: getGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54649,7 +55141,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessBackupRestoreJob' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -54665,7 +55157,8 @@ paths: summary: Return One Restore Job for One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupRestoreJob + x-xgen-operation-id-override: getServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: |- @@ -54675,7 +55168,7 @@ paths: externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups - operationId: listServerlessBackups + operationId: listGroupServerlessBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54711,7 +55204,8 @@ paths: summary: Return All Snapshots of One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupSnapshots + x-xgen-operation-id-override: listServerlessBackupSnapshots /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: |- @@ -54721,7 +55215,7 @@ paths: externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup - operationId: getServerlessBackup + operationId: getGroupServerlessBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54747,7 +55241,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessBackupSnapshot' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -54763,14 +55257,15 @@ paths: summary: Return One Snapshot of One Serverless Instance tags: - Cloud Backups - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupSnapshot + x-xgen-operation-id-override: getServerlessBackupSnapshot /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: description: createServerlessInstance url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance - operationId: getServerlessAutoIndexing + operationId: getGroupServerlessPerformanceAdvisorAutoIndexing parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -54803,16 +55298,17 @@ paths: summary: Return Serverless Auto-Indexing Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupServerlessPerformanceAdvisorAutoIndexing x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getServerlessAutoIndexing post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: description: createServerlessInstance url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance - operationId: setServerlessAutoIndexing + operationId: setGroupServerlessPerformanceAdvisorAutoIndexing parameters: - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. @@ -54848,10 +55344,11 @@ paths: summary: Set Serverless Auto-Indexing Status tags: - Performance Advisor - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setGroupServerlessPerformanceAdvisorAutoIndexing x-xgen-method-verb-override: customMethod: "True" verb: set + x-xgen-operation-id-override: setServerlessAutoIndexing /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: |- @@ -54861,7 +55358,7 @@ paths: externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster - operationId: deleteServerlessInstance + operationId: deleteGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -54896,7 +55393,11 @@ paths: summary: Remove One Serverless Instance from One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: deleteInstance + x-xgen-operation-id-override: deleteServerlessInstance get: description: |- Returns details for one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -54905,7 +55406,7 @@ paths: externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster - operationId: getServerlessInstance + operationId: getGroupServerlessInstance parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -54924,7 +55425,7 @@ paths: schema: $ref: '#/components/schemas/ServerlessInstanceDescription' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -54942,7 +55443,11 @@ paths: summary: Return One Serverless Instance from One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: getInstance + x-xgen-operation-id-override: getServerlessInstance patch: description: |- Updates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -54951,7 +55456,7 @@ paths: externalDocs: description: updateFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster - operationId: updateServerlessInstance + operationId: updateGroupServerlessInstance parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -54993,11 +55498,15 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateGroupServerlessInstance + x-xgen-method-verb-override: + customMethod: false + verb: updateInstance + x-xgen-operation-id-override: updateServerlessInstance /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns all Service Accounts for the specified Project. - operationId: listProjectServiceAccounts + operationId: listGroupServiceAccounts parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/itemsPerPage' @@ -55023,10 +55532,10 @@ paths: summary: Return All Project Service Accounts tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccounts post: description: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. - operationId: createProjectServiceAccount + operationId: createGroupServiceAccount parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -55060,11 +55569,11 @@ paths: summary: Create One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: description: Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. - operationId: deleteProjectServiceAccount + operationId: deleteGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -55095,10 +55604,10 @@ paths: summary: Remove One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccount get: description: Returns one Service Account in the specified Project. - operationId: getProjectServiceAccount + operationId: getGroupServiceAccount parameters: - $ref: '#/components/parameters/groupId' - description: The Client ID of the Service Account. @@ -55118,7 +55627,7 @@ paths: schema: $ref: '#/components/schemas/GroupServiceAccount' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -55132,10 +55641,10 @@ paths: summary: Return One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getGroupServiceAccount patch: description: Updates one Service Account in the specified Project. - operationId: updateProjectServiceAccount + operationId: updateGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -55176,11 +55685,11 @@ paths: summary: Update One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateGroupServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: get: description: Returns all access list entries that you configured for the specified Service Account for the project. - operationId: listProjectServiceAccountAccessList + operationId: listGroupServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -55215,10 +55724,11 @@ paths: summary: Return All Access List Entries for One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccountAccessList + x-xgen-operation-id-override: listAccessList post: description: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. - operationId: createProjectServiceAccountAccessList + operationId: createGroupServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -55268,11 +55778,12 @@ paths: summary: Add Access List Entries for One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountAccessList + x-xgen-operation-id-override: createAccessList /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. - operationId: deleteProjectServiceAccountAccessListEntry + operationId: deleteGroupServiceAccountAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55312,11 +55823,15 @@ paths: summary: Remove One Access List Entry from One Project Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: deleteEntry + x-xgen-operation-id-override: deleteGroupAccessEntry /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets: post: description: Create a secret for the specified Service Account in the specified Project. - operationId: createProjectServiceAccountSecret + operationId: createGroupServiceAccountSecret parameters: - $ref: '#/components/parameters/groupId' - description: The Client ID of the Service Account. @@ -55357,11 +55872,12 @@ paths: summary: Create One Project Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountSecret + x-xgen-operation-id-override: createGroupSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: description: Deletes the specified Service Account secret. - operationId: deleteProjectServiceAccountSecret + operationId: deleteGroupServiceAccountSecret parameters: - description: The Client ID of the Service Account. in: path @@ -55397,11 +55913,12 @@ paths: summary: Delete One Project Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountSecret + x-xgen-operation-id-override: deleteGroupSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: post: description: Assigns the specified Service Account to the specified Project. - operationId: addProjectServiceAccount + operationId: inviteGroupServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -55441,11 +55958,11 @@ paths: summary: Assign One Service Account to One Project tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/inviteGroupServiceAccount /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectSettings + operationId: getGroupSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55457,7 +55974,7 @@ paths: schema: $ref: '#/components/schemas/GroupSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -55471,10 +55988,10 @@ paths: summary: Return Project Settings tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupSettings patch: description: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: updateProjectSettings + operationId: updateGroupSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55505,11 +56022,11 @@ paths: summary: Update Project Settings tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupSettings /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. - operationId: listStreamInstances + operationId: listGroupStreamWorkspaces parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -55537,10 +56054,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamWorkspaces + x-xgen-method-verb-override: + customMethod: false + verb: listWorkspaces + x-xgen-operation-id-override: listStreamWorkspaces post: description: Creates one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: createStreamInstance + operationId: createGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55575,11 +56096,15 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: createWorkspace + x-xgen-operation-id-override: createStreamWorkspace /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamInstance + operationId: deleteGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55609,10 +56134,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: deleteWorkspace + x-xgen-operation-id-override: deleteStreamWorkspace get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: getStreamInstance + operationId: getGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55634,7 +56163,7 @@ paths: schema: $ref: '#/components/schemas/StreamsTenant' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" description: OK "400": @@ -55652,10 +56181,14 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: getWorkspace + x-xgen-operation-id-override: getStreamWorkspace patch: description: Update one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: updateStreamInstance + operationId: updateGroupStreamWorkspace parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55696,11 +56229,15 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamWorkspace + x-xgen-method-verb-override: + customMethod: false + verb: updateWorkspace + x-xgen-operation-id-override: updateStreamWorkspace /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' - operationId: downloadStreamTenantAuditLogs + operationId: downloadGroupStreamAuditLogs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55751,14 +56288,15 @@ paths: summary: Download Audit Logs for One Atlas Stream Processing Instance tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadGroupStreamAuditLogs x-xgen-method-verb-override: customMethod: "True" verb: download + x-xgen-operation-id-override: downloadAuditLogs /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: listStreamConnections + operationId: listGroupStreamConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -55792,10 +56330,11 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamConnections + x-xgen-operation-id-override: listStreamConnections post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: createStreamConnection + operationId: createGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55838,11 +56377,12 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamConnection + x-xgen-operation-id-override: createStreamConnection /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamConnection + operationId: deleteGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55880,10 +56420,11 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamConnection + x-xgen-operation-id-override: deleteStreamConnection get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getStreamConnection + operationId: getGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -55906,7 +56447,7 @@ paths: schema: $ref: '#/components/schemas/StreamsConnection' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-02-01" description: OK "401": @@ -55922,10 +56463,11 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamConnection + x-xgen-operation-id-override: getStreamConnection patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: updateStreamConnection + operationId: updateGroupStreamConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -55974,11 +56516,12 @@ paths: - Streams x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamConnection + x-xgen-operation-id-override: updateStreamConnection /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor: post: description: Create one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: createStreamProcessor + operationId: createGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56019,11 +56562,12 @@ paths: summary: Create One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamProcessor + x-xgen-operation-id-override: createStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: description: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: deleteStreamProcessor + operationId: deleteGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56057,10 +56601,11 @@ paths: summary: Delete One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamProcessor + x-xgen-operation-id-override: deleteStreamProcessor get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: getStreamProcessor + operationId: getGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56084,7 +56629,7 @@ paths: schema: $ref: '#/components/schemas/StreamsProcessorWithStats' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -56100,10 +56645,11 @@ paths: summary: Return One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessor + x-xgen-operation-id-override: getStreamProcessor patch: description: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: modifyStreamProcessor + operationId: updateGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56148,11 +56694,12 @@ paths: summary: Update One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamProcessor + x-xgen-operation-id-override: updateStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: startStreamProcessor + operationId: startGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56186,11 +56733,12 @@ paths: summary: Start One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessor + x-xgen-operation-id-override: startStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: startStreamProcessorWith + operationId: startGroupStreamProcessorWith parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56231,11 +56779,12 @@ paths: summary: Start One Stream Processor With Options tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessorWith + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessorWith + x-xgen-operation-id-override: startStreamProcessorWith /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: description: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: stopStreamProcessor + operationId: stopGroupStreamProcessor parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56269,11 +56818,12 @@ paths: summary: Stop One Stream Processor tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopGroupStreamProcessor + x-xgen-operation-id-override: stopStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: description: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. - operationId: listStreamProcessors + operationId: getGroupStreamProcessors parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56294,8 +56844,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-05-30" description: OK "400": @@ -56311,11 +56861,12 @@ paths: summary: Return All Stream Processors in One Stream Instance tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessors + x-xgen-operation-id-override: getStreamProcessors /api/atlas/v2/groups/{groupId}/streams/accountDetails: get: description: Returns the Account ID, and the VPC ID for the group and region specified. - operationId: getAccountDetails + operationId: getGroupStreamAccountDetails parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56350,14 +56901,15 @@ paths: summary: Return Account ID and VPC ID for One Project and Region tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamAccountDetails x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getAccountDetails /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: description: Returns a list of active incoming VPC Peering Connections. - operationId: getActiveVpcPeeringConnections + operationId: listGroupStreamActiveVpcPeeringConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56381,11 +56933,12 @@ paths: summary: Return All Active Incoming VPC Peering Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamActiveVpcPeeringConnections + x-xgen-operation-id-override: listActivePeeringConnections /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: get: description: Returns all Private Link connections for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. - operationId: listPrivateLinkConnections + operationId: listGroupStreamPrivateLinkConnections parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -56413,10 +56966,11 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamPrivateLinkConnections + x-xgen-operation-id-override: listPrivateLinkConnections post: description: Creates one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: createPrivateLinkConnection + operationId: createGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56453,11 +57007,12 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: createPrivateLinkConnection /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: delete: description: Deletes one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. - operationId: deletePrivateLinkConnection + operationId: deleteGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56487,10 +57042,11 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: deletePrivateLinkConnection get: description: Returns the details of one Private Link connection within the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getPrivateLinkConnection + operationId: getGroupStreamPrivateLinkConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56521,11 +57077,12 @@ paths: - Streams x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamPrivateLinkConnection + x-xgen-operation-id-override: getPrivateLinkConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: get: description: Returns a list of incoming VPC Peering Connections. - operationId: getVpcPeeringConnections + operationId: listGroupStreamVpcPeeringConnections parameters: - description: The Account ID of the VPC Peering connection/s. in: query @@ -56555,11 +57112,12 @@ paths: summary: Return All VPC Peering Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamVpcPeeringConnections + x-xgen-operation-id-override: listVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: delete: description: Deletes an incoming VPC Peering connection. - operationId: deleteVpcPeeringConnection + operationId: deleteGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56586,11 +57144,12 @@ paths: summary: Delete One VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: deleteVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: post: description: Requests the acceptance of an incoming VPC Peering connection. - operationId: acceptVpcPeeringConnection + operationId: acceptGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56624,11 +57183,12 @@ paths: summary: Accept One Incoming VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: acceptVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: post: description: Requests the rejection of an incoming VPC Peering connection. - operationId: rejectVpcPeeringConnection + operationId: rejectGroupStreamVpcPeeringConnection parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56655,11 +57215,12 @@ paths: summary: Reject One Incoming VPC Peering Connection tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectGroupStreamVpcPeeringConnection + x-xgen-operation-id-override: rejectVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: post: description: Creates one stream instance in the specified project with sample connections. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. - operationId: createStreamInstanceWithSampleConnections + operationId: withGroupStreamSampleConnections parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56692,11 +57253,12 @@ paths: summary: Create One Stream Instance with Sample Connections tags: - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/withGroupStreamSampleConnections + x-xgen-operation-id-override: withStreamSampleConnections /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: listProjectTeams + operationId: listGroupTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56725,13 +57287,13 @@ paths: summary: Return All Teams in One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listGroupTeams post: description: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: addAllTeamsToProject + operationId: addGroupTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -56766,7 +57328,7 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addGroupTeams x-xgen-method-verb-override: customMethod: "True" verb: add @@ -56776,7 +57338,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: removeProjectTeam + operationId: removeGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56806,13 +57368,13 @@ paths: summary: Remove One Team from One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeGroupTeam x-xgen-method-verb-override: customMethod: "True" verb: remove 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 + operationId: getGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56831,7 +57393,7 @@ paths: schema: $ref: '#/components/schemas/TeamRole' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -56847,13 +57409,13 @@ paths: 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 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getGroupTeam 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: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: updateTeamRoles + operationId: updateGroupTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56879,7 +57441,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedTeamRoleView' x-xgen-IPA-exception: - xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-107-update-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -56895,11 +57457,11 @@ paths: summary: Update Team Roles in One Project tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateGroupTeam /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getLdapConfiguration + operationId: getGroupUserSecurity parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56911,8 +57473,8 @@ paths: schema: $ref: '#/components/schemas/UserSecurity' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation. + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -56926,13 +57488,14 @@ paths: summary: Return LDAP or X.509 Configuration tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurity + x-xgen-operation-id-override: getUserSecurity patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. - operationId: saveLdapConfiguration + operationId: updateGroupUserSecurity parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56965,14 +57528,15 @@ paths: summary: Update LDAP or X.509 Configuration tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/updateGroupUserSecurity + x-xgen-operation-id-override: updateUserSecurity /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. - operationId: disableCustomerManagedX509 + operationId: disableGroupUserSecurityCustomerX509 parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -56995,14 +57559,15 @@ paths: summary: Disable Customer-Managed X.509 tags: - X.509 Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableGroupUserSecurityCustomerX509 x-xgen-method-verb-override: customMethod: "True" verb: disable + x-xgen-operation-id-override: disableSecurityCustomerX509 /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: deleteLdapConfiguration + operationId: deleteGroupUserSecurityLdapUserToDnMapping parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57026,11 +57591,12 @@ paths: summary: Remove LDAP User to DN Mapping tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteGroupUserSecurityLdapUserToDnMapping + x-xgen-operation-id-override: deleteLdapUserMapping /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: verifyLdapConfiguration + operationId: verifyGroupUserSecurityLdap parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57063,13 +57629,14 @@ paths: summary: Verify LDAP Configuration in One Project tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyGroupUserSecurityLdap x-xgen-method-verb-override: customMethod: "True" + x-xgen-operation-id-override: verifyUserSecurityLdap /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. - operationId: getLdapConfigurationStatus + operationId: getGroupUserSecurityLdapVerify parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57100,10 +57667,11 @@ paths: summary: Return Status of LDAP Configuration Verification in One Project tags: - LDAP Configuration - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurityLdapVerify x-xgen-method-verb-override: - customMethod: "False" + customMethod: false verb: get + x-xgen-operation-id-override: getUserSecurityVerify /api/atlas/v2/groups/{groupId}/users: get: description: |- @@ -57115,7 +57683,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: listProjectUsers + operationId: listGroupUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57171,10 +57739,10 @@ paths: summary: Return All MongoDB Cloud Users in One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listGroupUsers post: description: "Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. \n- If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. \n- If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. \n- If the user is already active in the project's organization, MongoDB Cloud grants access to the project. \n" - operationId: addProjectUser + operationId: addGroupUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57209,7 +57777,7 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUsers x-xgen-method-verb-override: customMethod: "True" verb: add @@ -57224,7 +57792,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeProjectUser + operationId: removeGroupUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57260,7 +57828,7 @@ paths: summary: Remove One MongoDB Cloud User from One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUser x-xgen-method-verb-override: customMethod: "True" verb: remove @@ -57271,7 +57839,7 @@ paths: **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. - operationId: getProjectUser + operationId: getGroupUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57304,12 +57872,12 @@ paths: summary: Return One MongoDB Cloud User in One Project tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getGroupUser /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: deprecated: true description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. - operationId: updateProjectRoles + operationId: updateGroupUserRoles parameters: - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal digit string that identifies the user to modify. @@ -57348,7 +57916,7 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupUserRoles /api/atlas/v2/groups/{groupId}/users/{userId}:addRole: post: description: |- @@ -57358,7 +57926,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: addProjectRole + operationId: addGroupUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57400,7 +57968,7 @@ paths: summary: Add One Project Role to One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUserRole /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole: post: description: |- @@ -57410,7 +57978,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeProjectRole + operationId: removeGroupUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' @@ -57452,11 +58020,11 @@ paths: summary: Remove One Project Role from One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUserRole /api/atlas/v2/groups/{groupId}:migrate: post: description: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: migrateProjectToAnotherOrg + operationId: migrateGroup parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/envelope' @@ -57486,11 +58054,11 @@ paths: summary: Migrate One Project to Another Organization tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateGroup /api/atlas/v2/groups/byName/{groupName}: get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. - operationId: getProjectByName + operationId: getGroupByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57525,11 +58093,11 @@ paths: summary: Return One Project by Name tags: - Projects - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupByName /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: listOrganizations + operationId: listOrgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -57564,13 +58132,13 @@ paths: summary: Return All Organizations tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgs post: description: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. externalDocs: description: Configure a Paying Organization url: https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization - operationId: createOrganization + operationId: createOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -57588,7 +58156,7 @@ paths: schema: $ref: '#/components/schemas/CreateOrganizationResponse' x-xgen-IPA-exception: - xgen-IPA-106-create-method-response-is-get-method-response: Content predates IPA validation + xgen-IPA-106-create-method-response-is-get-method-response: Content predates IPA validation. x-xgen-version: "2023-01-01" description: Created "400": @@ -57606,7 +58174,7 @@ paths: summary: Create One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrg /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -57615,7 +58183,7 @@ paths: - Organizations with active projects cannot be removed. - All projects in the organization must be removed before you can remove the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: deleteOrganization + operationId: deleteOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57642,10 +58210,10 @@ paths: summary: Remove One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrg get: description: Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: getOrganization + operationId: getOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57657,7 +58225,7 @@ paths: schema: $ref: '#/components/schemas/AtlasOrganization' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -57675,10 +58243,10 @@ paths: summary: Return One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrg patch: description: Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateOrganization + operationId: updateOrg parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57713,14 +58281,14 @@ paths: summary: Update One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrg /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: listApiKeys + operationId: listOrgApiKeys parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -57747,13 +58315,13 @@ paths: summary: Return All Organization API Keys tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeys post: description: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: createApiKey + operationId: createOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57784,14 +58352,14 @@ paths: summary: Create One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: deleteApiKey + operationId: deleteOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57820,13 +58388,13 @@ paths: summary: Remove One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKey get: description: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: getApiKey + operationId: getOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57845,7 +58413,7 @@ paths: schema: $ref: '#/components/schemas/ApiKeyUserDetails' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -57859,13 +58427,13 @@ paths: summary: Return One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKey patch: description: Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key - operationId: updateApiKey + operationId: updateOrgApiKey parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -57905,14 +58473,14 @@ paths: summary: Update One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateOrgApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization - operationId: listApiKeyAccessListsEntries + operationId: listOrgApiKeyAccessListEntries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -57946,10 +58514,14 @@ paths: summary: Return All Access List Entries for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeyAccessListEntries + x-xgen-method-verb-override: + customMethod: false + verb: listEntries + x-xgen-operation-id-override: listOrgAccessEntries post: description: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. - operationId: createApiKeyAccessList + operationId: createOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -57996,14 +58568,18 @@ paths: summary: Create One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: createEntry + x-xgen-operation-id-override: createOrgAccessEntry /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: deleteApiKeyAccessListEntry + operationId: deleteOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58042,16 +58618,17 @@ paths: summary: Remove One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKeyAccessListEntry x-xgen-method-verb-override: customMethod: "True" verb: deleteEntry + x-xgen-operation-id-override: deleteAccessEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Configure Atlas API Access url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list - operationId: getApiKeyAccessList + operationId: getOrgApiKeyAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58090,11 +58667,15 @@ paths: summary: Return One Access List Entry for One Organization API Key tags: - Programmatic API Keys - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: false + verb: getEntry + x-xgen-operation-id-override: getOrgAccessEntry /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. - operationId: createCostExplorerQueryProcess + operationId: createOrgBillingCostExplorerUsageProcess parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58126,11 +58707,15 @@ paths: summary: Create One Cost Explorer Query Process tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createOrgBillingCostExplorerUsageProcess + x-xgen-method-verb-override: + customMethod: false + verb: createProcess + x-xgen-operation-id-override: createCostExplorerProcess /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. - operationId: getCostExplorerQueryProcess + operationId: getOrgBillingCostExplorerUsage parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58177,17 +58762,18 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return results from a given Cost Explorer query, or notify that the results are not ready yet. + summary: Return Usage Details for One Cost Explorer Query tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgBillingCostExplorerUsage + x-xgen-operation-id-override: getCostExplorerUsage /api/atlas/v2/orgs/{orgId}/events: get: description: |- Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This resource remains under revision and may change. - operationId: listOrganizationEvents + operationId: listOrgEvents parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58236,7 +58822,7 @@ paths: schema: $ref: '#/components/schemas/OrgPaginatedEventView' x-xgen-IPA-exception: - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58252,7 +58838,7 @@ paths: summary: Return Events from One Organization tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrgEvents /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -58262,7 +58848,7 @@ paths: externalDocs: description: Return Events from One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents - operationId: getOrganizationEvent + operationId: getOrgEvent parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58287,7 +58873,7 @@ paths: schema: $ref: '#/components/schemas/EventViewForOrg' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -58301,11 +58887,11 @@ paths: summary: Return One Event from One Organization tags: - Events - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrgEvent /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. - operationId: getFederationSettings + operationId: getOrgFederationSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58317,7 +58903,7 @@ paths: schema: $ref: '#/components/schemas/OrgFederationSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58333,7 +58919,8 @@ paths: summary: Return Federation Settings for One Organization tags: - Federated Authentication - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getOrgFederationSettings + x-xgen-operation-id-override: getFederationSettings /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -58345,7 +58932,7 @@ paths: - Create different alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Member role. - operationId: listOrganizationProjects + operationId: getOrgGroups parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58365,9 +58952,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedAtlasGroupView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-response-has-no-input-fields: Content predates IPA validation - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58383,7 +58969,7 @@ paths: summary: Return All Projects in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgGroups /api/atlas/v2/orgs/{orgId}/invites: get: deprecated: true @@ -58394,7 +58980,7 @@ paths: externalDocs: description: Return All MongoDB Cloud Users in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers - operationId: listOrganizationInvitations + operationId: listOrgInvites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58414,12 +59000,12 @@ paths: $ref: '#/components/schemas/OrganizationInvitation' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58432,10 +59018,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return All Organization Invitations + summary: Return All Invitations in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgInvites patch: deprecated: true description: |- @@ -58445,7 +59031,7 @@ paths: externalDocs: description: Update One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser - operationId: updateOrganizationInvitation + operationId: updateOrgInvites parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58476,10 +59062,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Organization Invitation + summary: Update One Invitation in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInvites post: deprecated: true description: |- @@ -58489,7 +59075,7 @@ paths: externalDocs: description: Add One MongoDB Cloud User to One url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser - operationId: createOrganizationInvitation + operationId: createOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58520,10 +59106,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Invite One MongoDB Cloud User to One Atlas Organization + summary: Create Invitation for One MongoDB Cloud User in One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrgInvite /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: deprecated: true @@ -58534,7 +59120,7 @@ paths: externalDocs: description: Remove One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser - operationId: deleteOrganizationInvitation + operationId: deleteOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58562,10 +59148,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Remove One Organization Invitation + summary: Remove One Invitation from One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrgInvite get: deprecated: true description: |- @@ -58575,7 +59161,7 @@ paths: externalDocs: description: Return One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser - operationId: getOrganizationInvitation + operationId: getOrgInvite parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58594,7 +59180,7 @@ paths: $ref: '#/components/schemas/OrganizationInvitation' x-sunset: "2026-07-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58607,10 +59193,10 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Return One Organization Invitation + summary: Return One Invitation in One Organization by Invitation ID tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgInvite patch: deprecated: true description: |- @@ -58620,7 +59206,7 @@ paths: externalDocs: description: Update One MongoDB Cloud User in One Organization url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser - operationId: updateOrganizationInvitationById + operationId: updateOrgInviteById parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58658,16 +59244,19 @@ paths: $ref: '#/components/responses/notFound' "500": $ref: '#/components/responses/internalServerError' - summary: Update One Organization Invitation by Invitation ID + summary: Update One Invitation in One Organization by Invitation ID tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInviteById + x-xgen-method-verb-override: + customMethod: false + verb: updateById /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: listInvoices + operationId: listOrgInvoices parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -58738,7 +59327,7 @@ paths: schema: $ref: '#/components/schemas/PaginatedApiInvoiceMetadataView' x-xgen-IPA-exception: - xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation + xgen-IPA-105-list-method-response-is-get-method-response: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -58752,13 +59341,14 @@ paths: summary: Return All Invoices for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoices + x-xgen-operation-id-override: listInvoices /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: getInvoice + operationId: getOrgInvoice parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58788,7 +59378,7 @@ paths: schema: $ref: '#/components/schemas/BillingInvoice' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -58802,13 +59392,14 @@ paths: summary: Return One Invoice for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoice + x-xgen-operation-id-override: getInvoice /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*. - operationId: downloadInvoiceCsv + operationId: getOrgInvoiceCsv parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58846,11 +59437,12 @@ paths: summary: Return One Invoice as CSV for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoiceCsv + x-xgen-operation-id-override: getInvoiceCsv /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: description: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. - operationId: queryLineItemsFromSingleInvoice + operationId: searchOrgInvoiceLineItems parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -58891,11 +59483,12 @@ paths: summary: Return All Line Items for One Invoice by Invoice ID tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/searchOrgInvoiceLineItems + x-xgen-operation-id-override: searchInvoiceLineItems /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. - operationId: listPendingInvoices + operationId: listOrgInvoicePending parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -58919,11 +59512,12 @@ paths: summary: Return All Pending Invoices for One Organization tags: - Invoices - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoicePending + x-xgen-operation-id-override: listInvoicePending /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. - operationId: listSourceProjects + operationId: listOrgLiveMigrationAvailableProjects parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58937,7 +59531,7 @@ paths: $ref: '#/components/schemas/LiveImportAvailableProject' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-version: "2023-01-01" description: OK "400": @@ -58953,11 +59547,12 @@ paths: summary: Return All Projects Available for Migration tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listOrgLiveMigrationAvailableProjects + x-xgen-operation-id-override: listAvailableProjects /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: deleteLinkToken + operationId: deleteOrgLiveMigrationLinkTokens parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -58980,10 +59575,11 @@ paths: summary: Remove One Link-Token tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteOrgLiveMigrationLinkTokens + x-xgen-operation-id-override: deleteLinkTokens post: description: Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. - operationId: createLinkToken + operationId: createOrgLiveMigrationLinkToken parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -59016,14 +59612,15 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createOrgLiveMigrationLinkToken + x-xgen-operation-id-override: createLinkToken /api/atlas/v2/orgs/{orgId}/nonCompliantResources: get: description: Return all non-compliant resources for an org. externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: getResourcesNonCompliant + operationId: getOrgNonCompliantResources parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -59037,10 +59634,10 @@ paths: $ref: '#/components/schemas/ApiAtlasNonCompliantResourceView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59056,7 +59653,8 @@ paths: summary: Return All Non-Compliant Resources tags: - Resource Policies - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgNonCompliantResources + x-xgen-operation-id-override: getNonCompliantResources /api/atlas/v2/orgs/{orgId}/resourcePolicies: get: description: Return all Atlas Resource Policies for the org. @@ -59077,11 +59675,11 @@ paths: $ref: '#/components/schemas/ApiAtlasResourcePolicyView' type: array x-xgen-IPA-exception: - xgen-IPA-124-array-max-items: Schema predates IPA validation + xgen-IPA-124-array-max-items: Schema predates IPA validation. x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59211,7 +59809,7 @@ paths: schema: $ref: '#/components/schemas/ApiAtlasResourcePolicyView' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "400": @@ -59289,7 +59887,7 @@ paths: externalDocs: description: Atlas Resource Policies url: https://dochub.mongodb.org/core/atlas-resource-policies - operationId: validateAtlasResourcePolicy + operationId: validateOrgResourcePolicies parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -59328,11 +59926,12 @@ paths: summary: Validate 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/validateAtlasResourcePolicy + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateOrgResourcePolicies + x-xgen-operation-id-override: validateResourcePolicies /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns all Service Accounts for the specified Organization. - operationId: listServiceAccounts + operationId: listOrgServiceAccounts parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/itemsPerPage' @@ -59358,10 +59957,10 @@ paths: summary: Return All Organization Service Accounts tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccounts post: description: Creates one Service Account for the specified Organization. - operationId: createServiceAccount + operationId: createOrgServiceAccount parameters: - $ref: '#/components/parameters/orgId' - $ref: '#/components/parameters/envelope' @@ -59394,11 +59993,11 @@ paths: summary: Create One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: description: Deletes the specified Service Account. - operationId: deleteServiceAccount + operationId: deleteOrgServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -59428,10 +60027,10 @@ paths: summary: Delete One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccount get: description: Returns the specified Service Account. - operationId: getServiceAccount + operationId: getOrgServiceAccount parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -59451,7 +60050,7 @@ paths: schema: $ref: '#/components/schemas/OrgServiceAccount' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -59465,10 +60064,10 @@ paths: summary: Return One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccount patch: description: Updates the specified Service Account in the specified Organization. - operationId: updateServiceAccount + operationId: updateOrgServiceAccount parameters: - description: The Client ID of the Service Account. in: path @@ -59509,11 +60108,11 @@ paths: summary: Update One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateOrgServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList: get: description: Returns all access list entries that you configured for the specified Service Account for the organization. - operationId: listServiceAccountAccessList + operationId: listOrgServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -59548,10 +60147,11 @@ paths: summary: Return All Access List Entries for One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccountAccessList + x-xgen-operation-id-override: listOrgAccessList post: description: Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. - operationId: createServiceAccountAccessList + operationId: createOrgServiceAccountAccessList parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' @@ -59601,11 +60201,12 @@ paths: summary: Add Access List Entries for One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountAccessList + x-xgen-operation-id-override: createOrgAccessList /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified Service Account for the organization. You can't remove the requesting IP address from the access list. - operationId: deleteServiceAccountAccessListEntry + operationId: deleteOrgServiceAccountAccessListEntry parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59645,14 +60246,15 @@ paths: summary: Remove One Access List Entry from One Organization Service Account tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountAccessListEntry x-xgen-method-verb-override: - customMethod: "True" + customMethod: true verb: deleteEntry + x-xgen-operation-id-override: deleteOrgAccessEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: description: Returns a list of all projects the specified Service Account is a part of. - operationId: listServiceAccountProjects + operationId: getOrgServiceAccountGroups parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -59674,8 +60276,8 @@ paths: schema: $ref: '#/components/schemas/PaginatedServiceAccountGroup' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation - xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. + xgen-IPA-104-get-method-returns-single-resource: API predates IPA validation. x-xgen-version: "2024-08-05" description: OK "401": @@ -59689,11 +60291,12 @@ paths: summary: Return All Service Account Project Assignments tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccountGroups + x-xgen-operation-id-override: getServiceAccountGroups /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: description: Create a secret for the specified Service Account. - operationId: createServiceAccountSecret + operationId: createOrgServiceAccountSecret parameters: - $ref: '#/components/parameters/orgId' - description: The Client ID of the Service Account. @@ -59734,11 +60337,12 @@ paths: summary: Create One Organization Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountSecret + x-xgen-operation-id-override: createOrgSecret /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: description: Deletes the specified Service Account secret. - operationId: deleteServiceAccountSecret + operationId: deleteOrgServiceAccountSecret parameters: - description: The Client ID of the Service Account. in: path @@ -59774,11 +60378,12 @@ paths: summary: Delete One Organization Service Account Secret tags: - Service Accounts - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountSecret + x-xgen-operation-id-override: deleteOrgSecret /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 Member role. - operationId: getOrganizationSettings + operationId: getOrgSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59790,7 +60395,7 @@ paths: schema: $ref: '#/components/schemas/OrganizationSettings' x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -59804,10 +60409,10 @@ paths: summary: Return Settings for One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgSettings patch: description: Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. - operationId: updateOrganizationSettings + operationId: updateOrgSettings parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59842,14 +60447,14 @@ paths: summary: Update Settings for One Organization tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgSettings /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: listOrganizationTeams + operationId: listOrgTeams parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -59878,13 +60483,13 @@ paths: summary: Return All Teams in One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrgTeams post: description: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: createTeam + operationId: createOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59919,14 +60524,14 @@ paths: summary: Create One Team in One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createOrgTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: deleteTeam + operationId: deleteOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59957,13 +60562,13 @@ paths: summary: Remove One Team from One Organization tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteOrgTeam get: description: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: getTeamById + operationId: getOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -59996,13 +60601,13 @@ paths: summary: Return One Team by ID tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeam patch: description: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: renameTeam + operationId: renameOrgTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60044,7 +60649,7 @@ paths: summary: Rename One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameOrgTeam x-xgen-method-verb-override: customMethod: "True" verb: rename @@ -60059,7 +60664,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: listTeamUsers + operationId: listOrgTeamUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/itemsPerPage' @@ -60119,7 +60724,8 @@ paths: summary: Return All MongoDB Cloud Users Assigned to One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgTeamUsers + x-xgen-operation-id-override: listTeamUsers post: deprecated: true description: |- @@ -60129,7 +60735,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: addTeamUser + operationId: addOrgTeamUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60174,10 +60780,11 @@ paths: summary: Assign MongoDB Cloud Users in One Organization to One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addOrgTeamUsers x-xgen-method-verb-override: customMethod: "True" verb: add + x-xgen-operation-id-override: addTeamUsers /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: deprecated: true @@ -60188,7 +60795,7 @@ paths: externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: removeTeamUser + operationId: removeOrgTeamUserFromTeam parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60227,10 +60834,11 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeOrgTeamUserFromTeam x-xgen-method-verb-override: customMethod: "True" - verb: remove + verb: removeFromTeam + x-xgen-operation-id-override: removeUserFromTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: post: description: |- @@ -60240,7 +60848,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project endpoint' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation - operationId: addUserToTeam + operationId: addOrgTeamUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60280,7 +60888,7 @@ paths: summary: Add One MongoDB Cloud User to One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser: post: description: |- @@ -60290,7 +60898,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeUserFromTeam + operationId: removeOrgTeamUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60330,14 +60938,14 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgTeamUser /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams - operationId: getTeamByName + operationId: getOrgTeamByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60369,7 +60977,8 @@ paths: summary: Return One Team by Name tags: - Teams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeamByName + x-xgen-operation-id-override: getTeamByName /api/atlas/v2/orgs/{orgId}/users: get: description: |- @@ -60381,7 +60990,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: listOrganizationUsers + operationId: listOrgUsers parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60427,13 +61036,13 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgUsers post: description: |- Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. - operationId: createOrganizationUser + operationId: createOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60468,7 +61077,7 @@ paths: summary: Add One MongoDB Cloud User to One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrgUser /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: |- @@ -60480,7 +61089,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeOrganizationUser + operationId: removeOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60516,7 +61125,7 @@ paths: summary: Remove One MongoDB Cloud User from One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUser x-xgen-method-verb-override: customMethod: "True" verb: remove @@ -60527,7 +61136,7 @@ paths: **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. - operationId: getOrganizationUser + operationId: getOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60560,7 +61169,7 @@ paths: summary: Return One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrgUser patch: description: |- Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -60571,7 +61180,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: updateOrganizationUser + operationId: updateOrgUser parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60611,12 +61220,12 @@ paths: summary: Update One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrgUser /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: deprecated: true description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. - operationId: updateOrganizationRoles + operationId: updateOrgUserRoles parameters: - $ref: '#/components/parameters/orgId' - description: Unique 24-hexadecimal digit string that identifies the user to modify. @@ -60655,7 +61264,7 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgUserRoles /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: post: description: |- @@ -60667,7 +61276,7 @@ paths: externalDocs: description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project' url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: addOrganizationRole + operationId: addOrgUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60709,7 +61318,8 @@ paths: summary: Add One Organization Role to One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgUserRole + x-xgen-operation-id-override: addOrgRole /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: post: description: |- @@ -60721,7 +61331,7 @@ paths: externalDocs: description: Invite One MongoDB Cloud User to Join One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation - operationId: removeOrganizationRole + operationId: removeOrgUserRole parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/orgId' @@ -60761,11 +61371,12 @@ paths: summary: Remove One Organization Role from One MongoDB Cloud User tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUserRole + x-xgen-operation-id-override: removeOrgRole /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. - operationId: returnAllControlPlaneIpAddresses + operationId: listControlPlaneIpAddresses parameters: - $ref: '#/components/parameters/envelope' responses: @@ -60775,9 +61386,9 @@ paths: schema: $ref: '#/components/schemas/ControlPlaneIPAddresses' x-xgen-IPA-exception: - xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation - xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation - xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation + xgen-IPA-110-collections-response-define-links-array: Content predates IPA validation. + xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation. + xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation. x-xgen-version: "2023-11-15" description: OK "500": @@ -60786,7 +61397,8 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/listControlPlaneIpAddresses + x-xgen-operation-id-override: listControlPlaneAddresses /api/atlas/v2/users: post: deprecated: true @@ -60854,7 +61466,7 @@ paths: $ref: '#/components/schemas/CloudAppUser' x-sunset: "9999-12-31" x-xgen-IPA-exception: - xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation + xgen-IPA-104-get-method-returns-response-suffixed-object: API predates IPA validation. x-xgen-version: "2023-01-01" description: OK "401": @@ -60876,7 +61488,7 @@ paths: externalDocs: description: Return One Organization API Key url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey - operationId: getUserByUsername + operationId: getUserByName parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' @@ -60907,7 +61519,7 @@ paths: summary: Return One MongoDB Cloud User by Username tags: - MongoDB Cloud Users - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername + x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByName security: - ServiceAccounts: [] - DigestAuth: []