atlas alerts settings list

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.

Returns all alert configurations for your project.

Syntax

atlas alerts settings list [options]

Options

Name	Type	Required	Description
-h, --help		false	help for list
--limit	int	false	Number of items per results page.
-o, --output	string	false	Output format. Valid values are json, json-path, go-template, or go-template-file.
--page	int	false	Page number that specifies a page of results.
--projectId	string	false	Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

Inherited Options

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.

Examples

# Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json

Back

type

update