Skip to content

Commit da572f8

Browse files
Run make gen-docs
1 parent 9a14f2f commit da572f8

File tree

494 files changed

+986
-2509
lines changed

Some content is hidden

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

494 files changed

+986
-2509
lines changed

docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api accessTracking listAccessLogsByClusterName
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
16-
17-
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.
15+
Returns the access logs of one cluster identified by the cluster's name.
1916

2017
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.
2118

docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api accessTracking listAccessLogsByHostname
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
16-
17-
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.
15+
Returns the access logs of one cluster identified by the cluster's hostname.
1916

2017
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.
2118

docs/command/atlas-api-accessTracking.txt

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api accessTracking
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
16-
17-
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.
15+
Returns access logs for authentication attempts made to Atlas database deployments.
1916

2017
To view database access history, you must have either the Project Owner or Organization Owner role.
2118

@@ -54,8 +51,8 @@ Inherited Options
5451
Related Commands
5552
----------------
5653

57-
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
58-
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
54+
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - Returns the access logs of one cluster identified by the cluster's name.
55+
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - Returns the access logs of one cluster identified by the cluster's hostname.
5956

6057

6158
.. toctree::

docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations createAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
16-
17-
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.
15+
Creates one alert configuration for the specified project.
1916

2017
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.
2118

docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
16-
17-
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.
15+
Removes one alert configuration from the specified project.
1916

2017
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.
2118

docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations getAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
16-
17-
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.
15+
Returns the specified alert configuration from the specified project.
1916

2017
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.
2118

docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
16-
17-
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.
15+
Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
1916

2017
You can successfully call this endpoint with any assigned role.
2118

docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurations
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
16-
17-
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.
15+
Returns all alert configurations for one project.
1916

2017
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.
2118

docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
16-
17-
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.
15+
Returns all alert configurations set for the specified alert.
1916

2017
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.
2118

docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ atlas api alertConfigurations toggleAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
16-
17-
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.
15+
Enables or disables the specified alert configuration in the specified project.
1916

2017
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.
2118

0 commit comments

Comments
 (0)