Docs Menu

atlas alerts settings fields type

Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration.

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas alerts settings fields type [options]
Name
Type
Required
Description

-h, --help

false

help for type

-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.

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.

# Return a JSON-formatted list of accepted field types for the matchersFieldName option:
atlas alerts settings fields type --output json