Navigation

mongocli atlas integrations create

The integrations create command integrates Atlas with the specified third-party monitoring service. You can use the integrated third-party service to view and analyze performance metrics that Atlas collects about your cluster. You can also integrate third-party services with Atlas using the UI or the API.

You must have Organization Owner or Project Owner role to configure integrations with third-party services.

mongocli atlas integrations create DATADOG|datadog
--apiKey <api-key>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
--region <api-region>
Tip
See also:
Note

Use -h or --help to view the command-line help for this command.

Option
Type
Description
Required?
--apiKey
string
API key for Datadog.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no
--region
string

API URL region to use. Value can be one of the following:

  • EU for Europe
  • US for United States

The default value is US.

yes

The command returns the following output to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

<third-party-service> integration configured.

For the complete list of JSON fields returned by the command, see the public API reference. The default output contains only a subset of the fields returned by this command.

The following examples use the mongocli atlas integrations create command to integrate the specified third-party service with Atlas. It uses the default profile to access Atlas.

mongocli atlas integrations create FLOWDOCK --apiToken 123456 --flowName mySampleFlow --orgName mySampleOrg

The previous command returns the following output to the terminal.

Flowdock integration configured.
Give Feedback