mongocli atlas integrations describe

On this page

Syntax

Arguments
Options
Output
Example

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

The integrations describe command retrieves the settings for one third-party service integrated with Atlas. You can also retrieve the settings of a third-party service integrated with Atlas using the UI and API.

You must have Organization Owner or Project Owner role to retrieve the third-party integration settings.

Syntax

mongocli atlas integrations describe <third-party-service>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Arguments

Option	Type	Description	Required?
<third-party-service>	string	Name of the third-party service integrated with Atlas. Valid values are: `DATADOG` `FLOWDOCK` `NEW_RELIC` `OPS_GENIE` `PAGER_DUTY` `SLACK` `VICTOR_OPS` `WEBHOOK`	yes

Options

Option	Type	Description	Required?
`--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 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

Output

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

TYPE      API KEY     REGION
DATADOG   <API-key>   <API-region>

TYPE       API TOKEN      FLOW NAME     ORGANIZATION
FLOWDOCK   <API-token>   <flow-name>   <organization-name>

TYPE        ACCOUNT ID    LICENSE KEY    WRITE TOKEN     READ TOKEN
NEW_RELIC   <account-ID>  <license-key>  <write-token>   <read-token>

TYPE        API KEY     REGION
OPS_GENIE   <API-key>   <API-region>

TYPE         SERVICE KEY
PAGER_DUTY   <service-key>

TYPE    API TOKEN     TEAM          CHANNEL
SLACK   <API-token>   <team-name>   <channel-name>

TYPE         API KEY
VICTOR_OPS   <API-key>

TYPE      URL              SECRET
WEBHOOK   <webhooks-URL>   <webhooks-secret>

The above default output is a subset of the fields returned by this command. For the complete describe of JSON fields returned by this command, see the API reference.

Example

The following mongocli atlas integrations describe command describes the specified third-party service integrated with Atlas. It uses the default profile for accessing Atlas.

mongocli atlas integrations describe FLOWDOCK

The previous command prints the following to the terminal:

TYPE       API TOKEN                          FLOW NAME   ORGANIZATION
FLOWDOCK   a1234b5678c9d1e23b437784b4ec3XXX   Sample      MONGODB

mongocli atlas integrations describe PAGER_DUTY --output json

The previous command prints the following to the terminal:

{
  "type": "PAGER_DUTY",
  "serviceKey": "7fd036a6860e41469fe1fabcdefgh"
}

Back

List Third-Party Service Integrations

Integrate with Third-Party Service