Navigation

Update a Configuration for a Third-Party Service Integration

On this page

  • Syntax
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Response
Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

https://cloud.mongodb.com/api/atlas/v1.0

PUT /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}
Parameter
Required/Optional
Description
{GROUP-ID}
Required
Project identifier.
{INTEGRATION-TYPE}
Required

Third-party service integration identifier. Accepted values are:

  • PAGER_DUTY
  • SLACK
  • DATADOG
  • NEW_RELIC
  • OPS_GENIE
  • VICTOR_OPS
  • FLOWDOCK
  • WEBHOOK

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name
Type
Necessity
Description
Default
pageNum
integer
Optional
Page number, starting with one, that Atlas returns of the total number of objects.
1
itemsPerPage
integer
Optional
Number of items that Atlas returns per page, up to a maximum of 500.
100
includeCount
boolean
Optional
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
true
pretty
boolean
Optional
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether Atlas wraps 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.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

The request body should be a single integration view (i.e. a JSON configuration object) for a single third-party service. If a configuration of the same type already exists, the request will update the changed fields. If a configuration of the same type does not exist, it will be added. Always include a type property equal to the third-party service INTEGRATION_TYPE.

Service
Configuration Options
PagerDuty

You must provide the following fields when you configure a PagerDuty integration:

Property
Description
type
PAGER_DUTY
serviceKey
Your Service Key.
Slack
Important
Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page.

Legacy tokens will soon no longer be supported.

You must provide the following fields when you reconfigure an existing Slack integration:

Property
Description
type
SLACK
apiToken
Your API Token.
teamName
Your team name.

You may also include the following fields:

Property
Description
channelName
The channel name to reconfigure.
Datadog

You must provide the following fields when you configure a Datadog integration:

Property
Description
type
DATADOG
apiKey
Your API Key.
region
Indicates which API URL to use, either US or EU. Datadog will use US by default.
New Relic

You must provide the following fields when you configure a New Relic integration:

Important

Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.

To learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.

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

You must provide the following fields when you configure a Opsgenie integration:

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

You must provide the following fields when you configure a VictorOps integration:

Property
Description
type
VICTOR_OPS
apiKey
Your API Key.

You may also include the following fields:

Property
Description
routingKey
An optional field for your Routing Key.
Flowdock

You must provide the following fields when you configure a VictorOps integration:

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

You must provide the following fields when you configure webhook settings:

Property
Description
type
WEBHOOK
url
Your webhook URL.

You may also include the following fields:

Property
Description
secret
An optional field for your webhook secret.

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. The results array includes the integration view updated or added by the request.

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

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

Property
Description
type
DATADOG
apiKey
Your API Key.
region
Indicates which API URL is used, either US or EU. Datadog will use US by default.
New Relic

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

Important

Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.

To learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.

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.
curl -X PUT -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/5d791c84ff7a2522cc4f9aa1/integrations/FLOWDOCK" \
-H 'Content-Type: application/json' \
-d '{ "type": "FLOWDOCK", "flowName": "newFlowName", "apiToken": "223344", "orgName": "newOrgName" }'
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5d791c84ff7a2522cc4f9aa1/integrations/FLOWDOCK?pageNum=1&itemsPerPage=100",
"rel": "self"
}
],
"results": [
{
"apiKey": "112233",
"region": "US",
"type": "DATADOG"
},
{
"apiToken": "112233",
"channelName": "My Channel",
"teamName": "My Team",
"type": "SLACK"
},
{
"apiToken": "223344",
"flowName": "newFlowName",
"orgName": "newOrgName",
"type": "FLOWDOCK"
}
],
"totalCount": 3
}
Give Feedback

On this page

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