Docs Menu
Docs Home
/ /
Atlas Command Line Interface
/ /

atlas accessLogs list

Retrieve the access logs of a cluster identified by the cluster's name or hostname.

atlas accessLogs list [options]
Name
Type
Required
Description

--authResult

string

false

Authentication attempts that Atlas should return. When set to success, Atlas filters the log to return only successful authentication attempts. When set to fail, Atlas filters the log to return only failed authentication attempts.

--clusterName

string

false

Name of the cluster.

--end

string

false

Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the last entry that Atlas returns from the database access logs.

-h, --help

false

help for list

--hostname

string

false

The fully qualified domain name (FQDN) of the target node that should receive the authentication attempt.

--ip

string

false

IP address that attempted to authenticate with the database. Atlas filters the returned logs to include documents with only this IP address.

--nLog

int

false

Maximum number of log lines to return.

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file.

--projectId

string

false

Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

--start

string

false

Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the first entry that Atlas returns from the database access logs.

Name
Type
Required
Description

-P, --profile

string

false

Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Back

accessLogs

On this page