atlas api accessTracking listAccessLogsByClusterName
On this page
experimental: Returns the access logs of one cluster identified by the cluster's name.
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
Syntax
atlas api accessTracking listAccessLogsByClusterName [options]
Options
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 listAccessLogsByClusterName | |
--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 |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | 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
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. |