Skip to content

Commit 4f8aa70

Browse files
Project import generated by Copybara. (#952)
GitOrigin-RevId: 482d470e9fd420401c4f90bf04203b4f96df20b5 Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent b66b64a commit 4f8aa70

File tree

495 files changed

+3536
-691
lines changed

Some content is hidden

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

495 files changed

+3536
-691
lines changed

source/command/atlas-alerts-settings-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Options
5252
* - -f, --file
5353
- string
5454
- false
55-
- Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
55+
- Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
5656
* - -h, --help
5757
-
5858
- false

source/command/atlas-alerts-settings-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Options
6868
* - -f, --file
6969
- string
7070
- false
71-
- Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
71+
- Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
7272
* - -h, --help
7373
-
7474
- false

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ atlas api accessTracking listAccessLogsByClusterName
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.
1616

17-
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 API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName
17+
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 API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
18+
19+
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/Access-Tracking/operation/listAccessLogsByClusterName.
20+
21+
For more information and examples, see the referenced API documentation linked above.
1822

1923
Syntax
2024
------

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ atlas api accessTracking listAccessLogsByHostname
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.
1616

17-
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 API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname
17+
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 API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
18+
19+
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/Access-Tracking/operation/listAccessLogsByHostname.
20+
21+
For more information and examples, see the referenced API documentation linked above.
1822

1923
Syntax
2024
------

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alertConfigurations createAlertConfiguration
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.
1616

17-
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'createAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration
17+
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alert-Configurations/operation/createAlertConfiguration.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------
@@ -44,7 +51,7 @@ Options
4451
* - --file
4552
- string
4653
- false
47-
- path to the file which contains the api request contents
54+
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
4855
* - --groupId
4956
- string
5057
- true

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alertConfigurations deleteAlertConfiguration
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one alert configuration from the specified project.
1616

17-
To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'deleteAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration
17+
To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alert-Configurations/operation/deleteAlertConfiguration.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alertConfigurations getAlertConfiguration
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the specified alert configuration from the specified project.
1616

17-
To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration
17+
To use this resource, the requesting API Key must have the Project Read Only role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alert-Configurations/operation/getAlertConfiguration.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
1616

17-
You can successfully call this endpoint with any assigned role. This command is invoking the endpoint with OperationID: 'listAlertConfigurationMatchersFieldNames'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames
17+
You can successfully call this endpoint with any assigned role.
18+
19+
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/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames.
20+
21+
For more information and examples, see the referenced API documentation linked above.
1822

1923
Syntax
2024
------

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alertConfigurations listAlertConfigurations
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations for one project.
1616

17-
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 API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
17+
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 API Key must have the Project Read Only role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alert-Configurations/operation/listAlertConfigurations.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations set for the specified alert.
1616

17-
To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurationsByAlertId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId
17+
To use this resource, the requesting API Key must have the Project Read Only role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alert-Configurations/operation/listAlertConfigurationsByAlertId.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,17 @@ atlas api alertConfigurations toggleAlertConfiguration
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Enables or disables the specified alert configuration in the specified project.
1616

17-
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 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 invoking the endpoint with OperationID: 'toggleAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration
17+
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 API Key must have the Organization Owner or Project Owner role.
18+
19+
20+
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.
21+
22+
23+
This resource remains under revision and may change.
24+
25+
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/Alert-Configurations/operation/toggleAlertConfiguration.
26+
27+
For more information and examples, see the referenced API documentation linked above.
1828

1929
Syntax
2030
------
@@ -48,7 +58,7 @@ Options
4858
* - --file
4959
- string
5060
- false
51-
- path to the file which contains the api request contents
61+
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
5262
* - --groupId
5363
- string
5464
- true

source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,17 @@ atlas api alertConfigurations updateAlertConfiguration
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Updates one alert configuration in the specified project.
1616

17-
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting 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 invoking the endpoint with OperationID: 'updateAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration
17+
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
18+
19+
20+
NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project.
21+
22+
23+
This resource remains under revision and may change.
24+
25+
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/Alert-Configurations/operation/updateAlertConfiguration.
26+
27+
For more information and examples, see the referenced API documentation linked above.
1828

1929
Syntax
2030
------
@@ -48,7 +58,7 @@ Options
4858
* - --file
4959
- string
5060
- false
51-
- path to the file which contains the api request contents
61+
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
5262
* - --groupId
5363
- string
5464
- true

source/command/atlas-api-alerts-acknowledgeAlert.txt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alerts acknowledgeAlert
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Confirms receipt of one existing alert.
1616

17-
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 API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'acknowledgeAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert
17+
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 API Key must have the Organization Owner or Project Owner role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alerts/operation/acknowledgeAlert.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------
@@ -48,7 +55,7 @@ Options
4855
* - --file
4956
- string
5057
- false
51-
- path to the file which contains the api request contents
58+
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
5259
* - --groupId
5360
- string
5461
- true

source/command/atlas-api-alerts-getAlert.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alerts getAlert
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns one alert.
1616

17-
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 API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert
17+
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 API Key must have the Project Read Only role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alerts/operation/getAlert.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

source/command/atlas-api-alerts-listAlerts.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ atlas api alerts listAlerts
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alerts.
1616

17-
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 API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlerts'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
17+
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 API Key must have the Project Read Only role.
18+
19+
20+
This resource remains under revision and may change.
21+
22+
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/Alerts/operation/listAlerts.
23+
24+
For more information and examples, see the referenced API documentation linked above.
1825

1926
Syntax
2027
------

0 commit comments

Comments
 (0)