mongocli atlas integrations list

On this page

Syntax

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 list command retrieves the list of third-party services integrated with Atlas. You can also retrieve the list of third-party services integrated with Atlas using the UI and API.

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

Syntax

mongocli atlas integrations list|ls
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

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 field to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

TYPE
<third-party-service>

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

Example

The following mongocli atlas integrations list command retrieves the list of third-party services that you integrate with Atlas. It uses the default profile for accessing Atlas.

mongocli atlas integrations list

The previous command prints the following to the terminal:

TYPE
PAGER_DUTY
FLOWDOCK

mongocli atlas integrations list --output json

The previous command prints the following to the terminal:

{
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/integrations?pageNum=1\u0026itemsPerPage=100"
    }
  ],
  "results": [
    {
      "type": "PAGER_DUTY",
      "serviceKey": "wAbbTNGcSHyAqOSr4xyv"
    },
    {
      "type": "FLOWDOCK",
      "apiToken": "112233",
      "flowName": "mySampleFlow",
      "orgName": "mySampleOrg"
    }
  ],
  "totalCount": 2
}

Back

Integrations

Describe a Third-Party Service Integration