Skip to content

Commit 0fd1b4e

Browse files
apix-bot[bot]apix-bot[bot]
authored
Project import generated by Copybara. (#845)
GitOrigin-RevId: 8f7ea51fd29ad28166e457ec17148f37ec7673f7 Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent 810a904 commit 0fd1b4e

File tree

513 files changed

+45359
-6
lines changed

Some content is hidden

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

513 files changed

+45359
-6
lines changed

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

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. _atlas-api-accessTracking-listAccessLogsByClusterName:
2+
3+
====================================================
4+
atlas api accessTracking listAccessLogsByClusterName
5+
====================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`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.
16+
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
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas api accessTracking listAccessLogsByClusterName [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Options
30+
-------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - --authResult
41+
-
42+
- false
43+
- flag that indicates whether the response returns the successful authentication attempts only
44+
* - --clusterName
45+
- string
46+
- true
47+
- human-readable label that identifies the cluster
48+
* - --end
49+
- int
50+
- false
51+
- date and time when to stop retrieving database history
52+
* - --envelope
53+
-
54+
- false
55+
- flag that indicates whether Application wraps the response in an envelope JSON object
56+
* - --groupId
57+
- string
58+
- true
59+
- unique 24-hexadecimal digit string that identifies your project
60+
* - -h, --help
61+
-
62+
- false
63+
- help for listAccessLogsByClusterName
64+
* - --ipAddress
65+
- string
66+
- false
67+
- one Internet Protocol address that attempted to authenticate with the database
68+
* - --nLogs
69+
- int
70+
- false
71+
- maximum number of lines from the log to return
72+
* - --output
73+
- string
74+
- false
75+
- preferred api format, can be ["json", go-template] This value defaults to "json".
76+
* - --output-file
77+
- string
78+
- false
79+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
80+
* - --pretty
81+
-
82+
- false
83+
- flag that indicates whether the response body should be in the prettyprint format
84+
* - --start
85+
- int
86+
- false
87+
- date and time when MongoDB Cloud begins retrieving database history
88+
* - --version
89+
- string
90+
- false
91+
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
92+
93+
Inherited Options
94+
-----------------
95+
96+
.. list-table::
97+
:header-rows: 1
98+
:widths: 20 10 10 60
99+
100+
* - Name
101+
- Type
102+
- Required
103+
- Description
104+
* - -P, --profile
105+
- string
106+
- false
107+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
108+

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

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. _atlas-api-accessTracking-listAccessLogsByHostname:
2+
3+
=================================================
4+
atlas api accessTracking listAccessLogsByHostname
5+
=================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`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.
16+
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
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas api accessTracking listAccessLogsByHostname [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Options
30+
-------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - --authResult
41+
-
42+
- false
43+
- flag that indicates whether the response returns the successful authentication attempts only
44+
* - --end
45+
- int
46+
- false
47+
- date and time when to stop retrieving database history
48+
* - --envelope
49+
-
50+
- false
51+
- flag that indicates whether Application wraps the response in an envelope JSON object
52+
* - --groupId
53+
- string
54+
- true
55+
- unique 24-hexadecimal digit string that identifies your project
56+
* - -h, --help
57+
-
58+
- false
59+
- help for listAccessLogsByHostname
60+
* - --hostname
61+
- string
62+
- true
63+
- fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download
64+
* - --ipAddress
65+
- string
66+
- false
67+
- one Internet Protocol address that attempted to authenticate with the database
68+
* - --nLogs
69+
- int
70+
- false
71+
- maximum number of lines from the log to return
72+
* - --output
73+
- string
74+
- false
75+
- preferred api format, can be ["json", go-template] This value defaults to "json".
76+
* - --output-file
77+
- string
78+
- false
79+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
80+
* - --pretty
81+
-
82+
- false
83+
- flag that indicates whether the response body should be in the prettyprint format
84+
* - --start
85+
- int
86+
- false
87+
- date and time when MongoDB Cloud begins retrieving database history
88+
* - --version
89+
- string
90+
- false
91+
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
92+
93+
Inherited Options
94+
-----------------
95+
96+
.. list-table::
97+
:header-rows: 1
98+
:widths: 20 10 10 60
99+
100+
* - Name
101+
- Type
102+
- Required
103+
- Description
104+
* - -P, --profile
105+
- string
106+
- false
107+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
108+

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.. _atlas-api-accessTracking:
2+
3+
========================
4+
atlas api accessTracking
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns access logs for authentication attempts made to Atlas database deployments.
16+
17+
To view database access history, you must have either the Project Owner or Organization Owner role.
18+
19+
Options
20+
-------
21+
22+
.. list-table::
23+
:header-rows: 1
24+
:widths: 20 10 10 60
25+
26+
* - Name
27+
- Type
28+
- Required
29+
- Description
30+
* - -h, --help
31+
-
32+
- false
33+
- help for accessTracking
34+
35+
Inherited Options
36+
-----------------
37+
38+
.. list-table::
39+
:header-rows: 1
40+
:widths: 20 10 10 60
41+
42+
* - Name
43+
- Type
44+
- Required
45+
- Description
46+
* - -P, --profile
47+
- string
48+
- false
49+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
50+
51+
Related Commands
52+
----------------
53+
54+
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `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.
55+
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `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.
56+
57+
58+
.. toctree::
59+
:titlesonly:
60+
61+
listAccessLogsByClusterName </command/atlas-api-accessTracking-listAccessLogsByClusterName>
62+
listAccessLogsByHostname </command/atlas-api-accessTracking-listAccessLogsByHostname>
63+

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.. _atlas-api-alertConfigurations-createAlertConfiguration:
2+
3+
======================================================
4+
atlas api alertConfigurations createAlertConfiguration
5+
======================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.
16+
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
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas api alertConfigurations createAlertConfiguration [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Options
30+
-------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - --envelope
41+
-
42+
- false
43+
- flag that indicates whether Application wraps the response in an envelope JSON object
44+
* - --file
45+
- string
46+
- false
47+
- path to the file which contains the api request contents
48+
* - --groupId
49+
- string
50+
- true
51+
- unique 24-hexadecimal digit string that identifies your project
52+
* - -h, --help
53+
-
54+
- false
55+
- help for createAlertConfiguration
56+
* - --output
57+
- string
58+
- false
59+
- preferred api format, can be ["json", go-template] This value defaults to "json".
60+
* - --output-file
61+
- string
62+
- false
63+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
64+
* - --pretty
65+
-
66+
- false
67+
- flag that indicates whether the response body should be in the prettyprint format
68+
* - --version
69+
- string
70+
- false
71+
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
72+
73+
Inherited Options
74+
-----------------
75+
76+
.. list-table::
77+
:header-rows: 1
78+
:widths: 20 10 10 60
79+
80+
* - Name
81+
- Type
82+
- Required
83+
- Description
84+
* - -P, --profile
85+
- string
86+
- false
87+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
88+

0 commit comments

Comments
 (0)