atlas deployments logs

Get deployment logs.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Syntax

Command Syntax

atlas deployments logs [options]

Options

Name	Type	Required	Description
--deploymentName	string	false	Name of the deployment.
--end	int	false	Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time.
--force		false	Flag that indicates whether to overwrite the destination file.
-h, --help		false	help for logs
--hostname	string	false	Name of the host that stores the log files that you want to download.
--name	string	false	Name of the log file (e.g. mongodb.gz\|mongos.gz\|mongosqld.gz\|mongodb-audit-log.gz\|mongos-audit-log.gz).
-o, --output	string	false	Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId	string	false	Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--start	int	false	UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp.
--type	string	false	Type of deployment. Valid values are ATLAS or LOCAL.

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.

Back

list

pause