Navigation

Get All Configurations for Third-Party Service Integrations

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 /api/public/v1.0/groups/{GROUP-ID}/integrations

Request Path Parameters

Parameter Required/Optional Description
{GROUP-ID} Required Project identifier.

Request Query Parameters

Name Type Description Default
pageNum number One-based integer that returns a subsection of results. 1
itemsPerPage number Number of items to return per page, up to a maximum of 500. 100
pretty boolean Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 results object is an envelope. Cloud Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

The response includes a results array which lists all third-party integration configurations for the project as objects, and a totalCount of the services integrated with the project.

Each third-party integration configuration object includes a type property equal to its own integration type (e.g. "type": "PAGER_DUTY" for the PagerDuty service). 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 will contain the following fields:

Property Description
type PAGER_DUTY
serviceKey Your Service Key.
Slack

A returned Slack integration configuration object will contain the following fields:

Property Description
type SLACK
apiToken Your API Token.
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.
New Relic

A returned New Relic integration configuration object will contain the following fields:

Property Description
type NEW_RELIC
licenseKey Your License Key.
accountId Unique identifier of your New Relic account.
writeToken Your Insights Insert Key.
readToken Your Insights Query Key.
Opsgenie

A returned Opsgenie integration configuration object will contain the following fields:

Property Description
type OPS_GENIE
apiKey Your API Key.
region Indicates which API URL is used, either US or EU. Opsgenie will use US by default.
VictorOps

A returned VictorOps integration configuration object will contain the following fields:

Property Description
type VICTOR_OPS
apiKey Your API Key.

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

A returned Flowdock integration configuration object will contain the following fields:

Property Description
type FLOWDOCK
flowName Your Flowdock Flow name.
apiToken Your API Token.
orgName Your Flowdock organization name.
Webhook Settings

A returned webhook configuration object will contain the following fields:

Property Description
type WEBHOOK
url Your webhook URL.

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.

Example Request

curl -X GET -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/public/v1.0/groups/5d791c84ff7a2522cc4f9aa1/integrations"

Example Response

{
     "links": [
         {
             "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5d791c84ff7a2522cc4f9aa1/integrations?pageNum=1&itemsPerPage=100",
             "rel": "self"
         }
     ],
     "results": [
         {
             "serviceKey": "112233",
             "type": "PAGER_DUTY"
         },
         {
             "apiToken": "112233",
             "channelName": "My Channel",
             "teamName": "My Team",
             "type": "SLACK"
         },
     ],
     "totalCount": 2
 }