Skip to content

CLOUDP-316061: Update Autogenerated Commands #3861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apix-bot merged 1 commit into from
Apr 29, 2025
Merged

CLOUDP-316061: Update Autogenerated Commands #3861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions docs/command/atlas-api-cloudBackups-createExportBucket.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api cloudBackups createExportBucket
:depth: 1
:class: singlecol

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container.
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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 or Azure Blob Storage Container. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
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/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket.

Expand Down Expand Up @@ -173,3 +173,28 @@ Examples

.. Code end marker, please don't delete this comment

.. tab:: Example 3
:tabid: 2024-05-30_gcp

Create the file below and save it as ``payload.json``

.. code-block::

# GCP
{
"bucketName": "export-bucket",
"cloudProvider": "GCP",
"roleId": "668c5f0ed436263134491592"
}

.. Code end marker, please don't delete this comment

After creating ``payload.json``, run the command below in the same directory.

.. code-block::

# GCP
atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8

.. Code end marker, please don't delete this comment

2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Related Commands
* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Cancels one cloud backup restore job of one cluster from the specified project.
* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket.
* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Restores one snapshot of one cluster from the specified project.
* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container.
* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket.
* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Restores one snapshot of one serverless instance from the specified project.
* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes all cloud backup schedules for the specified cluster.
* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Deletes an Export Bucket.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts addProjectServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Assigns the specified Service Account to the specified Project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts createProjectServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount.

Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts createProjectServiceAccountAccessList

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList.

Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts createProjectServiceAccountSecret

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Create a secret for the specified Service Account in the specified Project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-createServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts createServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one Service Account for the specified Organization.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts createServiceAccountAccessList

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList.

Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts createServiceAccountSecret

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Create a secret for the specified Service Account.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteProjectServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount.

Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry.

Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Deletes the specified Service Account secret.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts deleteServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Deletes the specified Service Account.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. Available as a preview feature.
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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry.

Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts deleteServiceAccountSecret

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Deletes the specified Service Account secret.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts getProjectServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one Service Account in the specified Project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-getServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts getServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified Service Account.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts listProjectServiceAccountAccessList

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all access list entries that you configured for the specified Service Account for the project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts listProjectServiceAccounts

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all Service Accounts for the specified Project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts listServiceAccountAccessList

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all access list entries that you configured for the specified Service Account for the organization.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts listServiceAccountProjects

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns a list of all projects the specified Service Account is a part of.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts listServiceAccounts

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all Service Accounts for the specified Organization.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts updateProjectServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one Service Account in the specified Project.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 0 additions & 2 deletions docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ atlas api serviceAccounts updateServiceAccount

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates the specified Service Account in the specified Organization.

Available as a preview feature.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount.

For more information and examples, see the referenced API documentation linked above.
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-serviceAccounts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ atlas api serviceAccounts

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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. This feature is available as a Preview feature.
Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow.

Options
-------
Expand Down
Loading
Loading