Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
115 changes: 115 additions & 0 deletions docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
.. _atlas-api-accessTracking-getAccessHistoryCluster:

================================================
atlas api accessTracking getAccessHistoryCluster
================================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Returns the access logs of one cluster identified by the cluster's name.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistorycluster.

For more information and examples, see the referenced API documentation linked above.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas api accessTracking getAccessHistoryCluster [options]

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

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - --authResult
-
- false
- flag that indicates whether the response returns the successful authentication attempts only
* - --clusterName
- string
- true
- human-readable label that identifies the cluster
* - --end
- int
- false
- date and time when to stop retrieving database history
* - --envelope
-
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
* - -h, --help
-
- false
- help for getAccessHistoryCluster
* - --ipAddress
- string
- false
- one Internet Protocol address that attempted to authenticate with the database
* - --nLogs
- int
- false
- maximum number of lines from the log to return
* - -o, --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
* - --outputFile
- string
- false
- 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)
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
* - --start
- int
- false
- date and time when MongoDB Cloud begins retrieving database history
* - --version
- string
- false
- 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".

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- 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.

115 changes: 115 additions & 0 deletions docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
.. _atlas-api-accessTracking-getAccessHistoryProcess:

================================================
atlas api accessTracking getAccessHistoryProcess
================================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Returns the access logs of one cluster identified by the cluster's hostname.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupdbaccesshistoryprocess.

For more information and examples, see the referenced API documentation linked above.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas api accessTracking getAccessHistoryProcess [options]

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

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - --authResult
-
- false
- flag that indicates whether the response returns the successful authentication attempts only
* - --end
- int
- false
- date and time when to stop retrieving database history
* - --envelope
-
- false
- flag that indicates whether Application wraps the response in an envelope JSON object
* - --groupId
- string
- true
- unique 24-hexadecimal digit string that identifies your project
* - -h, --help
-
- false
- help for getAccessHistoryProcess
* - --hostname
- string
- true
- fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download
* - --ipAddress
- string
- false
- one Internet Protocol address that attempted to authenticate with the database
* - --nLogs
- int
- false
- maximum number of lines from the log to return
* - -o, --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
* - --outputFile
- string
- false
- 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)
* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
* - --start
- int
- false
- date and time when MongoDB Cloud begins retrieving database history
* - --version
- string
- false
- 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".

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- 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.

This file was deleted.

Loading
Loading