Skip to content

Commit 68b0e24

Browse files
Project import generated by Copybara. (#1122)
GitOrigin-RevId: e6e6fbf7c177b8c8cf62c7474065c420afb17169 Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent ed7b7bd commit 68b0e24

File tree

913 files changed

+8373
-4611
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

913 files changed

+8373
-4611
lines changed

source/command/atlas-accessLists-create.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLists create
55
========================
66

7-
.. meta::
8-
:description: Create an IP access list entry for your project using trusted IPs, AWS security group IDs, or CIDR notation without overwriting existing entries.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,11 @@ atlas accessLists create
1714

1815
Create an IP access list entry for your project.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
2022
The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project.
2123

2224
The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries.

source/command/atlas-accessLists-delete.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLists delete
55
========================
66

7-
.. meta::
8-
:description: Remove an IP access list entry from your Atlas project using the CLI, with options for confirmation and project specification.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,11 @@ atlas accessLists delete
1714

1815
Remove the specified IP access list entry from your project.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
2022
The command, when run without the force option, prompts you to confirm the operation.
2123

2224
To use this command, you must authenticate with a user account or an API key with the Read Write role.

source/command/atlas-accessLists-describe.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLists describe
55
==========================
66

7-
.. meta::
8-
:description: Retrieve details of a specified IP access list entry using the Atlas CLI command with options for output format and project ID.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,11 @@ atlas accessLists describe
1714

1815
Return the details for the specified IP access list entry.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
2022
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
2123

2224
Syntax

source/command/atlas-accessLists-list.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLists list
55
======================
66

7-
.. meta::
8-
:description: List all IP access entries for your project using the Atlas CLI command with various output and pagination options.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,11 @@ atlas accessLists list
1714

1815
Return all IP access list entries for your project.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
2022
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
2123

2224
Syntax

source/command/atlas-accessLists.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLists
55
=================
66

7-
.. meta::
8-
:description: Manage IP access lists for your Atlas project using the CLI, including creating, deleting, and listing entries.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,13 @@ atlas accessLists
1714

1815
Manage the list of IP addresses that can access your Atlas project.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
2024
Options
2125
-------
2226

source/command/atlas-accessLogs-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLogs list
1414

1515
Retrieve the access logs of a cluster identified by the cluster's name or hostname.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role.
1823

1924
Syntax

source/command/atlas-accessLogs.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
atlas accessLogs
55
================
66

7-
.. meta::
8-
:description: Retrieve access logs for a cluster using the Atlas CLI command with optional profile settings.
9-
107
.. default-domain:: mongodb
118

129
.. contents:: On this page
@@ -17,6 +14,13 @@ atlas accessLogs
1714

1815
Return the access logs for a cluster.
1916

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
2024
Options
2125
-------
2226

source/command/atlas-alerts-acknowledge.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts acknowledge
1414

1515
Acknowledges the specified alert for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax
@@ -61,6 +66,8 @@ Options
6166
-
6267
- false
6368
- Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command.
69+
70+
Mutually exclusive with --until.
6471
* - -h, --help
6572
-
6673
- false
@@ -78,6 +85,8 @@ Options
7885
- false
7986
- ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged.
8087

88+
Mutually exclusive with --forever.
89+
8190
Inherited Options
8291
-----------------
8392

source/command/atlas-alerts-describe.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts describe
1414

1515
Return the details for the specified alert for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

source/command/atlas-alerts-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts list
1414

1515
Return all alerts for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

0 commit comments

Comments
 (0)