Get the Configuration of a Third-Party Service Integration
On this page
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://{OPSMANAGER-HOST}:{PORT}/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:
|
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 For endpoints that return a list of results, the | false |
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:
| ||||||||||||||||||||
Slack | A returned Slack integration configuration object contains the following fields:
| ||||||||||||||||||||
Datadog | A returned Datadog integration configuration object contains the following fields:
| ||||||||||||||||||||
HipChat | A returned HipChat integration configuration object contains the following fields:
| ||||||||||||||||||||
Opsgenie | A returned Opsgenie integration configuration object contains the following fields:
To set | ||||||||||||||||||||
VictorOps | A returned VictorOps integration configuration object contains the following fields:
The configuration object may also contain the following fields, depending on your configuration:
| ||||||||||||||||||||
Webhook Settings | A returned webhook configuration object contains the following fields:
The configuration object may also contain the following fields, depending on your configuration:
| ||||||||||||||||||||
Microsoft Teams | A returned Microsoft Teams configuration object will contain the following fields:
| ||||||||||||||||||||
Prometheus | A returned Prometheus configuration object will contain the following fields:
The configuration object may also contain the following fields, depending on your configuration:
|
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" }