Get the Configuration of a Third-Party Service Integration

On this page

Syntax

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response Elements
Example Request
Example Response

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Syntax

GET /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

Request Path Parameters

Parameter	Necessity	Description
`{PROJECT-ID}`	Required	Project identifier.
`{INTEGRATION-TYPE}`	Required	Third-party service identifier. Accepted values are: `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK` `PROMETHEUS`

Request Query Parameters

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	`1`
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	`100`
pretty	boolean	Optional	Flag that indicates whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. For endpoints that return a list of results, the `content` object is an envelope. Cloud Manager adds the `status` field to the response body.	`false`
backupJobsEnabledOnly	boolean	Optional	Flag indicating whether to exclude daemons not enabled for backing up databases from the response. Set this to `false` to include daemon configurations with the `backupJobsEnabled` flag set to `false`.	`true`

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response Elements

The response returns the specified third-party integration configuration object if that service has been configured. If it has not been configured, the response will return an INTEGRATION_NOT_CONFIGURED error.

Each third-party integration configuration object includes a type property equal to its own integration type (like "type": "PAGER_DUTY"). Additionally, each third-party service configuration object provides details specific to that service. The following lists the properties returned for each third-party service configuration object:

Service

Result

PagerDuty

A returned PagerDuty integration configuration object contains the following fields:

Property	Description
`type`	`PAGER_DUTY`
`serviceKey`	Your Service Key. After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you: View or edit the alert through the UI. Query the third-party integration settings through the API.

Slack

A returned Slack integration configuration object contains the following fields:

Property	Description
`type`	`SLACK`
`apiToken`	Your API Token. After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you: View or edit the alert through the UI. Query the third-party integration settings through the API.
`teamName`	Your team name. This field may not be present with a legacy Slack integration.
`channelName`	The configured Slack channel name. An empty string if the value is not set.

Opsgenie

A returned Opsgenie integration configuration object contains the following fields:

Property	Description
`type`	`OPS_GENIE`
`apiKey`	Your API Key. After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you: View or edit the alert through the UI. Query the third-party integration settings through the API.
`region`	Indicates which API URL to use, either `US` or `EU`. Opsgenie defaults to `US`.

VictorOps

A returned VictorOps integration configuration object contains the following fields:

Property	Description
`type`	`VICTOR_OPS`
`apiKey`	Your API Key. After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you: View or edit the alert through the UI. Query the third-party integration settings through the API.

The configuration object may also contain the following fields, depending on your configuration:

Property	Description
`routingKey`	An optional field returned if you have a Routing Key configured.

Webhook Settings

A returned webhook configuration object contains the following fields:

Property	Description
`type`	`WEBHOOK`
`url`	Your webhook URL. After creating a webhook notification, the URL is partially redacted when you view or edit the alert, and the secret is completely redacted.

The configuration object may also contain the following fields, depending on your configuration:

Property	Description
`secret`	An optional field returned if your webhook is configured with a secret.

Microsoft Teams

A returned Microsoft Teams configuration object will contain the following fields:

Property	Description
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	Your Microsoft Teams incoming webhook URL. When you view or edit the alert for a webhook notification, the URL appears partially redacted, and the secret appears completely redacted.

Prometheus

A returned Prometheus configuration object will contain the following fields:

Property	Description
`type`	`PROMETHEUS`
`username`	Your Prometheus username.
`listenAddress`	The IP address and port your Prometheus instance will reach out to.
`serviceDiscovery`	Indicates which service discovery method is used, either `file` or `http`.
`scheme`	Your Prometheus protocol scheme configured for requests, either `http` or `https`. If you configure `https`, you must specify `tlsPemPath`.
`enabled`	Whether your cluster has Prometheus enabled.

The configuration object may also contain the following fields, depending on your configuration:

Property	Description
`tlsPemPassword`	An optional field returned if you have a password for your PEM file.
`tlsPemPath`	An optional field returned if you have an absolute path to your PEM file.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/PAGER_DUTY"

Example Response

{
  "serviceKey": "******7890",
  "type": "PAGER_DUTY"
}

Back

Get All Configurations

Create a Configuration